# @huggingface/hub

## Classes

- [HubApiError](classes/HubApiError)
- [InvalidApiResponseFormatError](classes/InvalidApiResponseFormatError)
- [JsonStreamParseError](classes/JsonStreamParseError)
- [SafetensorParseError](classes/SafetensorParseError)
- [\_\_internal\_XetBlob](classes/_internal_XetBlob)

## Interfaces

- [AuthInfo](interfaces/AuthInfo)
- [CachedFileInfo](interfaces/CachedFileInfo)
- [CachedRepoInfo](interfaces/CachedRepoInfo)
- [CachedRevisionInfo](interfaces/CachedRevisionInfo)
- [CommitCopyFile](interfaces/CommitCopyFile)
- [CommitData](interfaces/CommitData)
- [CommitDeletedEntry](interfaces/CommitDeletedEntry)
- [CommitEditFile](interfaces/CommitEditFile)
- [CommitEditFileParams](interfaces/CommitEditFileParams)
- [CommitFile](interfaces/CommitFile)
- [CommitInfo](interfaces/CommitInfo)
- [CommitOutput](interfaces/CommitOutput)
- [CopyDestination](interfaces/CopyDestination)
- [CopyFilesEntry](interfaces/CopyFilesEntry)
- [CopyProgressEvent](interfaces/CopyProgressEvent)
- [CopySource](interfaces/CopySource)
- [Credenciais](interfaces/Credentials)
- [DatasetEntry](interfaces/DatasetEntry)
- [FileDownloadInfoOutput](interfaces/FileDownloadInfoOutput)
- [HFCacheInfo](interfaces/HFCacheInfo)
- [JobVolume](interfaces/JobVolume)
- [LfsPathInfo](interfaces/LfsPathInfo)
- [ListFileEntry](interfaces/ListFileEntry)
- [MlxQuantizationConfig](interfaces/MlxQuantizationConfig)
- [ModelConfig](interfaces/ModelConfig)
- [ModelDerivedFields](interfaces/ModelDerivedFields)
- [ModelEntry](interfaces/ModelEntry)
- [OAuthResult](interfaces/OAuthResult)
- [ParallelDownloadOptions](interfaces/ParallelDownloadOptions)
- [PathInfo](interfaces/PathInfo)
- [QuantizationConfig](interfaces/QuantizationConfig)
- [RangeEditCacheEntry](interfaces/RangeEditCacheEntry)
- [RepoId](interfaces/RepoId)
- [SafetensorsIndexJson](interfaces/SafetensorsIndexJson)
- [SafetensorsShardFileInfo](interfaces/SafetensorsShardFileInfo)
- [SecurityFileStatus](interfaces/SecurityFileStatus)
- [SpaceEntry](interfaces/SpaceEntry)
- [SpaceResourceConfig](interfaces/SpaceResourceConfig)
- [SpaceResourceRequirement](interfaces/SpaceResourceRequirement)
- [SpaceRuntime](interfaces/SpaceRuntime)
- [TensorInfo](interfaces/TensorInfo)
- [UserInfo](interfaces/UserInfo)
- [WhoAmIApp](interfaces/WhoAmIApp)
- [WhoAmIOrg](interfaces/WhoAmIOrg)
- [WhoAmIUser](interfaces/WhoAmIUser)
- [XetFileInfo](interfaces/XetFileInfo)
- [XetReadToken](interfaces/XetReadToken)

## Aliases de Tipo

### AccessToken

Ƭ **AccessToken**: `string`

Na verdade `hf_${string}`, mas, por conveniência, usando o tipo string

#### Definido em[[accesstoken.defined-in]]

[packages/hub/src/types/public.ts:28](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L28)

___

### AccessTokenRole

Ƭ **AccessTokenRole**: ``"admin"`` \| ``"write"`` \| ``"contributor"`` \| ``"read"``

#### Definido em[[accesstokenrole.defined-in]]

[packages/hub/src/types/public.ts:98](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L98)

___

### AuthType

Ƭ **AuthType**: ``"access_token"`` \| ``"app_token"`` \| ``"app_token_as_user"``

#### Definido em[[authtype.defined-in]]

[packages/hub/src/types/public.ts:100](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L100)

___

### CommitOperation

Ƭ **CommitOperation**: [`CommitDeletedEntry`](interfaces/CommitDeletedEntry) \| [`CommitFile`](interfaces/CommitFile) \| [`CommitEditFile`](interfaces/CommitEditFile) \| [`CommitCopyFile`](interfaces/CommitCopyFile)

#### Definido em[[commitoperation.defined-in]]

[packages/hub/src/lib/commit.ts:124](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L124)

___

### CommitParams

Ƭ **CommitParams**: \{ `abortSignal?`: `AbortSignal` ; `branch?`: `string` ; `description?`: `string` ; `fetch?`: typeof [`__type`](classes/_internal_XetBlob#__type) ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `maxFolderDepth?`: `number` ; `operations`: [`CommitOperation`](modules#commitoperation)[] ; `parentCommit?`: `string` ; `rangeEditCache?`: [`RangeEditCache`](modules#rangeeditcache) ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `title`: `string` ; `useWebWorkers?`: `boolean` \| \{ `minSize?`: `number` ; `poolSize?`: `number`  } ; `useXet?`: `boolean`  } & `Partial`\<`CredentialsParams`\>

#### Definido em[[commitparams.defined-in]]

[packages/hub/src/lib/commit.ts:131](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L131)

___

### CommitProgressEvent

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

#### Definido em[[commitprogressevent.defined-in]]

[packages/hub/src/lib/commit.ts:201](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L201)

___

### ContentSource

Ƭ **ContentSource**: `Blob` \| `URL`

#### Definido em[[contentsource.defined-in]]

[packages/hub/src/lib/commit.ts:45](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L45)

___

### Dtype

Ƭ **Tipo de dados**: ``"F64"`` \| ``"F32"`` \| ``"C64"`` \| ``"F16"`` \| ``"F8_E4M3"`` \| ``"F8_E4M3FNUZ"`` \| ``"F8_E5M2"`` \| ``"F8_E5M2FNUZ"`` \| ``"F8_E8M0"`` \| ``"E8M0"`` \| ``"F6_E3M2"`` \| ``"F6_E2M3"`` \| ``"F4"`` \| ``"FP4"`` \| ``"BF16"`` \| ``"I64"`` \| ``"U64"`` \| ``"I32"`` \| ``"U32"`` \| ``"I16"`` \| ``"I8"`` \| ``"U16"`` \| ``"U8"`` \| ``"UE8"`` \| ``"BOOL"``

#### Definido em[[dtype.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:291](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L291)

___

### JsonStreamEvent

Ƭ **JsonStreamEvent**: \{ `type`: ``"startObject"``  } \| \{ `type`: ``"endObject"``  } \| \{ `type`: ``"startArray"``  } \| \{ `type`: ``"endArray"``  } \| \{ `key`: `string` ; `type`: ``"key"``  } \| \{ `type`: ``"value"`` ; `value`: `string` \| `number` \| `boolean` \| ``null``  }

Parser JSON incremental (estilo SAX), minimal e sem dependências.

`JSON.parse` requer que o documento inteiro esteja na memória duas vezes (a string de origem + a árvore de objetos resultante), o que o torna inviável para documentos grandes cujo conteúdo *relevante* é minúsculo — por exemplo, um `model.safetensors.index.json` de um MoE grande, onde o `weight_map` de 60 MB existe apenas para nos informar os ~100 nomes de arquivos de shards distintos.

Este parser, em vez disso, emite um fluxo de eventos plano conforme os bytes chegam, permitindo que o consumidor mantenha apenas o que lhe interessa e deixe que tudo o mais seja coletado pelo coletor de lixo. O uso de memória é limitado pelo tamanho do maior token individual (string / número), e não pelo tamanho do documento.

A implementação é uma máquina de estados retomável: qualquer token pode ser dividido entre fronteiras de blocos (incluindo sequências UTF-8 de múltiplos bytes e escapes `\uXXXX`).

Rigor: a gramática aceita é a RFC 8259 (a mesma de `JSON.parse`), exceto por algumas verificações que custariam muito para pouco benefício aqui — em particular, as *formas* numéricas são validadas por `Number()` em vez da máquina de estados, de modo que alguns poucos inputs rejeitados por `JSON.parse` são aceitos. Tudo o que `JSON.parse` aceita é aceito, com valores idênticos.

**`Example`**

```ts
for await (const event of streamJson(blob.stream())) {
  if (event.type === "key") { ... }
}
```

#### Definido em[[jsonstreamevent.defined-in]]

[packages/hub/src/utils/streamJson.ts:27](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/utils/streamJson.ts#L27)

___

### ModelAdditionalField

Ƭ **ModelAdditionalField**: `Exclude`\ \| keyof [`ModelDerivedFields`](interfaces/ModelDerivedFields)

#### Definido em[[modeladditionalfield.defined-in]]

[packages/hub/src/lib/list-models.ts:51](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L51)

___

### PipelineType

Ƭ **PipelineType**: keyof typeof `PIPELINE_DATA`

#### Definido em[[pipelinetype.defined-in]]

packages/tasks/dist/commonjs/pipelines.d.ts:380

___

### RangeEditCache

Ƭ **RangeEditCache**: `Map`\<`string`, [`RangeEditCacheEntry`](interfaces/RangeEditCacheEntry)\>

Estado em memória de um arquivo previamente escrito por meio do caminho de edição por intervalo, indexado por seu hash xet. Permite que um append subsequente (ou uma edição do último termo do arquivo) pule completamente as chamadas de API de reconstrução e de hashes de chunks de arquivo: o estado parcial da árvore merkle e os hashes de verificação já são conhecidos.

Passe a mesma instância de [RangeEditCache](modules#rangeeditcache) para chamadas sucessivas de `commit` que adicionam ao mesmo arquivo para evitar chamar as APIs de metadados do CAS a cada adição.

#### Definido em[[rangeeditcache.defined-in]]

[packages/hub/src/utils/rangeEdit.ts:16](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/utils/rangeEdit.ts#L16)

___

### RepoDesignation

Ƭ **Designação do repositório**: [`RepoId`](interfaces/RepoId) \| [`RepoFullName`](modules#repofullname)

#### Definido em[[repodesignation.defined-in]]

[packages/hub/src/types/public.ts:17](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L17)

___

### RepoFullName

Ƭ **RepoFullName**: `string` \| \`spaces/$\{string}\` \| \`datasets/$\{string}\` \| \`buckets/$\{string}\` \| \`kernels/$\{string}\`

#### Definido em[[repofullname.defined-in]]

[packages/hub/src/types/public.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L10)

___

### RepoType

Ƭ **RepoType**: ``"space"`` \| ``"dataset"`` \| ``"model"`` \| ``"bucket"`` \| ``"kernel"``

#### Definido em[[repotype.defined-in]]

[packages/hub/src/types/public.ts:3](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L3)

___

### ResolveModelAdditionalFields

Ƭ **ResolveModelAdditionalFields**\<`T`\>: `Pick`\<`ApiModelInfo`, `T` & keyof `ApiModelInfo`\> & `Pick`\<[`ModelDerivedFields`](interfaces/ModelDerivedFields), `T` & keyof [`ModelDerivedFields`](interfaces/ModelDerivedFields)\>

#### Parâmetros de tipo[[resolvemodeladditionalfields.type-parameters]]

| Nome | Tipo |
| :------ | :------ |
| `T` | estende [`ModelAdditionalField`](modules#modeladditionalfield) |

#### Definido em[[resolvemodeladditionalfields.defined-in]]

[packages/hub/src/lib/list-models.ts:55](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L55)

___

### SafetensorsFileHeader

Ƭ **SafetensorsFileHeader**: `Record`\<[`TensorName`](modules#tensorname), [`TensorInfo`](interfaces/TensorInfo)\> & \{ `__metadata__?`: \{ `total_parameters?`: `string` \| `number`  } & `Record`\<`string`, `string`\>  }

#### Definido em[[safetensorsfileheader.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:324](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L324)

___

### SafetensorsParseFromRepo

Ƭ **SafetensorsParseFromRepo**: \{ `filepaths`: `string`[] ; `header`: [`SafetensorsFileHeader`](modules#safetensorsfileheader) ; `parameterCount?`: `Partial`\<`Record`\<[`Dtype`](modules#dtype), `number`\>\> ; `parameterTotal?`: `number` ; `sharded`: ``false``  } \| \{ `filepaths`: `string`[] ; `headers`: [`SafetensorsShardedHeaders`](modules#safetensorsshardedheaders) ; `index`: [`SafetensorsIndexJson`](interfaces/SafetensorsIndexJson) ; `parameterCount?`: `Partial`\<`Record`\<[`Dtype`](modules#dtype), `number`\>\> ; `parameterTotal?`: `number` ; `sharded`: ``true``  }

#### Definido em[[safetensorsparsefromrepo.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:348](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L348)

___

### SafetensorsShardedHeaders

Ƭ **SafetensorsShardedHeaders**: `Record`\<`FileName`, [`SafetensorsFileHeader`](modules#safetensorsfileheader)\>

#### Definido em[[safetensorsshardedheaders.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:346](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L346)

___

### SpaceHardwareFlavor

Ƭ **SpaceHardwareFlavor**: ``"cpu-basic"`` \| ``"cpu-upgrade"`` \| ``"cpu-performance"`` \| ``"cpu-xl"`` \| ``"sprx8"`` \| ``"zero-a10g"`` \| ``"inf2x6"`` \| ``"t4-small"`` \| ``"t4-medium"`` \| ``"l4x1"`` \| ``"l4x4"`` \| ``"l40sx1"`` \| ``"l40sx4"`` \| ``"l40sx8"`` \| ``"a10g-small"`` \| ``"a10g-large"`` \| ``"a10g-largex2"`` \| ``"a10g-largex4"`` \| ``"a100-large"`` \| ``"a100x4"`` \| ``"a100x8"`` \| ``"h200"`` \| ``"h200x2"`` \| ``"h200x4"`` \| ``"h200x8"`` \| ``"rtx-pro-6000"`` \| ``"rtx-pro-6000x2"`` \| ``"rtx-pro-6000x4"`` \| ``"rtx-pro-6000x8"``

#### Definido em[[spacehardwareflavor.defined-in]]

[packages/hub/src/types/public.ts:53](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L53)

___

### SpaceSdk

Ƭ **SpaceSdk**: ``"streamlit"`` \| ``"gradio"`` \| ``"docker"`` \| ``"static"``

#### Definido em[[spacesdk.defined-in]]

[packages/hub/src/types/public.ts:84](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L84)

___

### SpaceStage

Ƭ **SpaceStage**: ``"NO_APP_FILE"`` \| ``"CONFIG_ERROR"`` \| ``"BUILDING"`` \| ``"BUILD_ERROR"`` \| ``"RUNNING"`` \| ``"RUNNING_BUILDING"`` \| ``"RUNTIME_ERROR"`` \| ``"DELETING"`` \| ``"PAUSED"`` \| ``"SLEEPING"``

#### Definido em[[spacestage.defined-in]]

[packages/hub/src/types/public.ts:86](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L86)

___

### TensorName

Ƭ **TensorName**: `string`

#### Definido em[[tensorname.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:290](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L290)

___

### WhoAmI

Ƭ **WhoAmI**: [`WhoAmIApp`](interfaces/WhoAmIApp) \| [`WhoAmIOrg`](interfaces/WhoAmIOrg) \| [`WhoAmIUser`](interfaces/WhoAmIUser)

#### Definido em[[whoami.defined-in]]

[packages/hub/src/lib/who-am-i.ts:52](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/who-am-i.ts#L52)

## Variáveis

### DATASET\_EXPANDABLE\_KEYS

• `Const` **DATASET\_EXPANDABLE\_KEYS**: somente leitura [``"author"``, ``"cardData"``, ``"citation"``, ``"createdAt"``, ``"disabled"``, ``"description"``, ``"downloads"``, ``"downloadsAllTime"``, ``"gated"``, ``"gitalyUid"``, ``"lastModified"``, ``"likes"``, ``"paperswithcode_id"``, ``"private"``, ``"sha"``, ``"tags"``]

#### Definido em[[datasetexpandablekeys.defined-in]]

[packages/hub/src/lib/list-datasets.ts:18](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-datasets.ts#L18)

___

### DATASET\_EXPAND\_KEYS

• `Const` **DATASET\_EXPAND\_KEYS**: somente leitura [``"private"``, ``"downloads"``, ``"gated"``, ``"likes"``, ``"lastModified"``]

#### Definido em[[datasetexpandkeys.defined-in]]

[packages/hub/src/lib/list-datasets.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-datasets.ts#L10)

___

### DEFAULT\_REVISION

• `Const` **DEFAULT\_REVISION**: ``"main"``

#### Definido em[[defaultrevision.defined-in]]

[packages/hub/src/lib/snapshot-download.ts:13](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/snapshot-download.ts#L13)

___

### DIFFUSERS\_SAFETENSORS\_ARQUIVO

• `Const` **DIFFUSERS\_SAFETENSORS\_FILE**: ``"diffusion_pytorch_model.safetensors"``

#### Definido em[[diffuserssafetensorsfile.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:21](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L21)

___

### DIFFUSERS\_SAFETENSORS\_INDEX\_FILE

• `Const` **DIFFUSERS\_SAFETENSORS\_INDEX\_FILE**: ``"diffusion_pytorch_model.safetensors.index.json"``

#### Definido em[[diffuserssafetensorsindexfile.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:22](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L22)

___

### DIFFUSERS\_WEIGHTS\_SUBFOLDERS

• `Const` **DIFFUSERS\_WEIGHTS\_SUBFOLDERS**: somente leitura [``"transformer"``, ``"unet"``]

#### Definido em[[diffusersweightssubfolders.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:23](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L23)

___

### HUB\_URL

• `Const` **HUB\_URL**: ``"https://huggingface.co"``

URL base do Hugging Face Hub.

#### Definido em[[huburl.defined-in]]

[packages/hub/src/consts.ts:4](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/consts.ts#L4)

___

### MODEL\_DERIVED\_FIELD\_TO\_API\_KEY

• `Const` **MODEL\_DERIVED\_FIELD\_TO\_API\_KEY**: `Record`\

#### Definido em[[modelderivedfieldtoapikey.defined-in]]

[packages/hub/src/lib/list-models.ts:47](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L47)

___

### MODEL\_EXPANDABLE\_KEYS

• `Const` **MODEL\_EXPANDABLE\_KEYS**: somente leitura [``"author"``, ``"cardData"``, ``"config"``, ``"createdAt"``, ``"disabled"``, ``"downloads"``, ``"downloadsAllTime"``, ``"gated"``, ``"gitalyUid"``, ``"inferenceProviderMapping"``, ``"lastModified"``, ``"library_name"``, ``"likes"``, ``"model-index"``, ``"pipeline_tag"``, ``"private"``, ``"safetensors"``, ``"sha"``, ``"spaces"``, ``"tags"``, ``"transformersInfo"``]

#### Definido em[[modelexpandablekeys.defined-in]]

[packages/hub/src/lib/list-models.ts:19](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L19)

___

### MODEL\_EXPAND\_KEYS

• `Const` **MODEL\_EXPAND\_KEYS**: somente leitura [``"pipeline_tag"``, ``"private"``, ``"gated"``, ``"downloads"``, ``"likes"``, ``"lastModified"``]

#### Definido em[[modelexpandkeys.defined-in]]

[packages/hub/src/lib/list-models.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L10)

___

### REGEX\_COMMIT\_HASH

• `Const` **REGEX\_COMMIT\_HASH**: `RegExp`

#### Definido em[[regexcommithash.defined-in]]

[packages/hub/src/lib/download-file-to-cache-dir.ts:16](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/download-file-to-cache-dir.ts#L16)

___

### REPO\_ID\_SEPARATOR

• `Const` **REPO\_ID\_SEPARATOR**: `string` = `"--"`

#### Definido em[[repoidseparator.defined-in]]

[packages/hub/src/lib/cache-management.ts:25](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L25)

___

### RE\_SAFETENSORS\_FILE

• `Const` **RE\_SAFETENSORS\_FILE**: `RegExp`

#### Definido em[[resafetensorsfile.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:26](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L26)

___

### RE\_SAFETENSORS\_INDEX\_FILE

• `Const` **RE\_SAFETENSORS\_INDEX\_FILE**: `RegExp`

#### Definido em[[resafetensorsindexfile.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:27](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L27)

___

### RE\_SAFETENSORS\_SHARD\_FILE

• `Const` **RE\_SAFETENSORS\_SHARD\_FILE**: `RegExp`

#### Definido em[[resafetensorsshardfile.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:28](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L28)

___

### SAFETENSORS\_ARQUIVO

• `Const` **SAFETENSORS\_FILE**: ``"model.safetensors"``

#### Definido em[[safetensorsfile.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:17](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L17)

___

### SAFETENSORS\_INDEX\_FILE

• `Const` **SAFETENSORS\_INDEX\_FILE**: ``"model.safetensors.index.json"``

#### Definido em[[safetensorsindexfile.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:18](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L18)

___

### SPACE\_EXPANDABLE\_KEYS

• `Const` **SPACE\_EXPANDABLE\_KEYS**: somente leitura [``"author"``, ``"cardData"``, ``"datasets"``, ``"disabled"``, ``"gitalyUid"``, ``"lastModified"``, ``"createdAt"``, ``"likes"``, ``"private"``, ``"runtime"``, ``"sdk"``, ``"sha"``, ``"subdomain"``, ``"tags"``, ``"models"``]

#### Definido em[[spaceexpandablekeys.defined-in]]

[packages/hub/src/lib/list-spaces.ts:16](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-spaces.ts#L16)

___

### SPACE\_EXPAND\_KEYS

• `Const` **SPACE\_EXPAND\_KEYS**: somente leitura [``"sdk"``, ``"likes"``, ``"private"``, ``"lastModified"``]

#### Definido em[[spaceexpandkeys.defined-in]]

[packages/hub/src/lib/list-spaces.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-spaces.ts#L10)

## Funções

### \_\_internal\_sha256

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

#### Parâmetros[[internalsha256.parameters]]

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

#### Retorna[[internalsha256.returns]]

`AsyncGenerator`\<`number`, `string`\>

sha em hexadecimal

**`Yields`**

progress (0-1)

#### Definido em[[internalsha256.defined-in]]

[packages/hub/src/utils/sha256.ts:72](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/utils/sha256.ts#L72)

___

### assertSafeShardFilename

▸ **assertSafeShardFilename**(`filename`): `void`

`weight_map` os nomes de arquivo vêm de um arquivo do repositório, portanto são controlados pelo atacante: eles devem permanecer como caminhos relativos dentro do próprio diretório do índice.

Uma verificação literal de `includes("..")` não é suficiente, porque a URL em que o nome do arquivo termina é analisada pelo parser de URL do WHATWG *após* a verificação, e esse parser decodifica em percentual os segmentos de ponto: `%2e%2e` (ou `.%2e`, `%2E%2E`, …) é um segmento `..` para ele, então ele escapa do repositório — e com uma credencial anexada, a solicitação chega autorizada à URL de `resolve` de outro repositório.

Portanto, decodifique antes de validar (repetidamente, para capturar `%252e%252e`) e rejeite qualquer coisa que não seja um caminho relativo simples.

#### Parâmetros[[assertsafeshardfilename.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `filename` | `string` |

#### Retorna[[assertsafeshardfilename.returns]]

`void`

#### Definido em[[assertsafeshardfilename.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:511](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L511)

___

### cancelJob

▸ **cancelJob**(`params`): `Promise`\<`ApiJob`\>

Cancelar um job.

#### Parâmetros[[canceljob.parameters]]

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

#### Retorna[[canceljob.returns]]

`Promise`\<`ApiJob`\>

#### Definido em[[canceljob.defined-in]]

[packages/hub/src/lib/jobs/cancel-job.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/cancel-job.ts#L11)

___

### checkRepoAccess

▸ **checkRepoAccess**(`params`): `Promise`\<`void`\>

Verifique se temos acesso de leitura a um repositório.

Lance um erro [HubApiError](classes/HubApiError) se não tivermos acesso. HubApiError.statusCode será 401, 403 ou 404.

#### Parâmetros[[checkrepoaccess.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation)  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[checkrepoaccess.returns]]

`Promise`\<`void`\>

#### Definido em[[checkrepoaccess.defined-in]]

[packages/hub/src/lib/check-repo-access.ts:14](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/check-repo-access.ts#L14)

___

### commit

▸ **commit**(`params`): `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Parâmetros[[commit.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | [`CommitParams`](modules#commitparams) |

#### Retorna[[commit.returns]]

`Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

undefined para uploads de bucket, CommitOutput caso contrário

#### Definido em[[commit.defined-in]]

[packages/hub/src/lib/commit.ts:1032](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L1032)

___

### commitIter

▸ **commitIter**(`params`): `AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent), [`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

Função interna por enquanto, usada pelo commit.

Pode ser exposto posteriormente para oferecer informações detalhadas sobre o progresso

CommitOutput não está presente para commits de bucket

#### Parâmetros[[commititer.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | [`CommitParams`](modules#commitparams) |

#### Retorna[[commititer.returns]]

`AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent), [`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Definido em[[commititer.defined-in]]

[packages/hub/src/lib/commit.ts:220](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L220)

___

### commitIterBucket

▸ **commitIterBucket**(`params`): `AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent)\>

#### Parâmetros[[commititerbucket.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | [`CommitParams`](modules#commitparams) |

#### Retorna[[commititerbucket.returns]]

`AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent)\>

#### Definido em[[commititerbucket.defined-in]]

[packages/hub/src/lib/commit.ts:776](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L776)

___

### computeNumOfParamsByDtypeSingleFile

▸ **computeNumOfParamsByDtypeSingleFile**(`header`, `quantConfig?`, `expertDtype?`): `Partial`\<`Record`\<[`Dtype`](modules#dtype), `number`\>\>

Soma os parâmetros por dtype para o cabeçalho de um arquivo, aplicando os fatores de empacotamento de quantização e ignorando os tensores de controle.

#### Parâmetros[[computenumofparamsbydtypesinglefile.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `header` | [`SafetensorsFileHeader`](modules#safetensorsfileheader) |
| `quantConfig?` | [`QuantizationConfig`](interfaces/QuantizationConfig) |
| `expertDtype?` | `string` |

#### Retorna[[computenumofparamsbydtypesinglefile.returns]]

`Partial`\<`Record`\<[`Dtype`](modules#dtype), `number`\>\>

#### Definido em[[computenumofparamsbydtypesinglefile.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:1379](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L1379)

___

### copyFile

▸ **copyFile**(`params`): `Promise`\<`undefined`\>

Copie um arquivo individual de um repositório/bucket de origem para o bucket de destino.

A cópia é feita no servidor (sem transferência de dados) quando o arquivo de origem é baseado em xet. Para arquivos de repositório pequenos que não são baseados em xet (por exemplo, `config.json`), o arquivo é baixado e reenviado para o bucket de destino no mesmo commit.

Arquivos de ponteiro LFS que não foram migrados para xet são rejeitados antecipadamente (caso contrário, seria necessário baixar o blob LFS completo).

#### Parâmetros[[copyfile.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `destination`: [`CopyDestination`](interfaces/CopyDestination) ; `source`: [`CopySource`](interfaces/CopySource)  } & `SharedParams` |

#### Retorna[[copyfile.returns]]

`Promise`\<`undefined`\>

**`Example`**

```ts
await copyFile({
  source: {
    repo: { type: "model", name: "username/my-model" },
    path: "model.safetensors",
  },
  destination: {
    repo: { type: "bucket", name: "username/my-bucket" },
    path: "models/my-model/model.safetensors",
  },
  accessToken: "hf_...",
});
```

#### Definido em[[copyfile.defined-in]]

[packages/hub/src/lib/copy-files.ts:111](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L111)

___

### copyFileIter

▸ **copyFileIter**(`params`): `AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\>

Variante de iterador assíncrono de [copyFile](modules#copyfile) que produz [CopyProgressEvent](interfaces/CopyProgressEvent)s durante o download de arquivos de origem não-xet (arquivos com suporte xet são copiados no lado do servidor e não emitem eventos). Consulte [copyFile](modules#copyfile) para as semânticas.

#### Parâmetros[[copyfileiter.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `destination`: [`CopyDestination`](interfaces/CopyDestination) ; `source`: [`CopySource`](interfaces/CopySource)  } & `SharedParams` |

#### Retorna[[copyfileiter.returns]]

`AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\>

**`Example`**

```ts
for await (const event of copyFileIter({ source, destination, accessToken })) {
  console.log(`downloaded ${event.path} (${event.downloaded}/${event.total})`);
}
```

#### Definido em[[copyfileiter.defined-in]]

[packages/hub/src/lib/copy-files.ts:144](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L144)

___

### copyFiles

▸ **copyFiles**(`params`): `Promise`\<`undefined`\>

Copie vários arquivos (possivelmente de repositórios/buckets de origem diferentes) para o bucket de destino em um único commit.

Para arquivos de origem com suporte a xet, a cópia é executada no servidor, sem transferência de dados. Para arquivos de origem sem suporte a xet (geralmente arquivos de repositório pequenos armazenados no git), o arquivo é baixado e reenviado como parte do mesmo commit.

Arquivos de ponteiro LFS que não foram migrados para xet são rejeitados antecipadamente.

#### Parâmetros[[copyfiles.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `destination`: `BucketDesignation` ; `files`: [`CopyFilesEntry`](interfaces/CopyFilesEntry)[]  } & `SharedParams` |

#### Retorna[[copyfiles.returns]]

`Promise`\<`undefined`\>

**`Example`**

```ts
await copyFiles({
  destination: { type: "bucket", name: "username/my-bucket" },
  files: [
    {
      source: {
        repo: { type: "bucket", name: "username/other-bucket" },
        path: "data.bin",
      },
      destinationPath: "data.bin",
    },
    {
      source: {
        repo: { type: "model", name: "username/my-model" },
        path: "model.safetensors",
      },
      destinationPath: "models/my-model/model.safetensors",
    },
  ],
  accessToken: "hf_...",
});
```

#### Definido em[[copyfiles.defined-in]]

[packages/hub/src/lib/copy-files.ts:199](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L199)

___

### copyFilesIter

▸ **copyFilesIter**(`params`): `AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\>

Variante de iterador assíncrono de [copyFiles](modules#copyfiles) que produz [CopyProgressEvent](interfaces/CopyProgressEvent)s durante o download de arquivos de origem não-xet (arquivos com suporte xet são copiados no lado do servidor e não emitem eventos). Consulte [copyFiles](modules#copyfiles) para as semânticas.

#### Parâmetros[[copyfilesiter.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `destination`: `BucketDesignation` ; `files`: [`CopyFilesEntry`](interfaces/CopyFilesEntry)[]  } & `SharedParams` |

#### Retorna[[copyfilesiter.returns]]

`AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\>

#### Definido em[[copyfilesiter.defined-in]]

[packages/hub/src/lib/copy-files.ts:219](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L219)

___

### copyFolder

▸ **copyFolder**(`params`): `Promise`\<`undefined`\>

Copie uma pasta (recursivamente) de um repositório/bucket de origem para o bucket de destino em um único commit.

Os caminhos por arquivo são resolvidos em relação a [CopySource.path](interfaces/CopySource#path); a própria pasta de origem não é preservada no destino, a menos que [CopyDestination.path](interfaces/CopyDestination#path) a mantenha.

#### Parâmetros[[copyfolder.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `destination`: `Omit`\<[`CopyDestination`](interfaces/CopyDestination), ``"path"``\> & \{ `path?`: `string`  } ; `source`: `Omit`\<[`CopySource`](interfaces/CopySource), ``"path"``\> & \{ `path?`: `string`  }  } & `SharedParams` |

#### Retorna[[copyfolder.returns]]

`Promise`\<`undefined`\>

**`Example`**

```ts
// Copy an entire dataset under "datasets/my-dataset/" in the bucket
await copyFolder({
  source: { repo: { type: "dataset", name: "username/my-dataset" } },
  destination: {
    repo: { type: "bucket", name: "username/my-bucket" },
    path: "datasets/my-dataset/",
  },
  accessToken: "hf_...",
});

// Copy a subfolder
await copyFolder({
  source: {
    repo: { type: "bucket", name: "username/src-bucket" },
    path: "models/",
  },
  destination: {
    repo: { type: "bucket", name: "username/dst-bucket" },
    path: "backup/",
  },
  accessToken: "hf_...",
});
```

#### Definido em[[copyfolder.defined-in]]

[packages/hub/src/lib/copy-files.ts:277](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L277)

___

### copyFolderIter

▸ **copyFolderIter**(`params`): `AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\>

Variante de iterador assíncrono de [copyFolder](modules#copyfolder) que produz [CopyProgressEvent](interfaces/CopyProgressEvent)s durante o download de arquivos de origem não-xet (arquivos com suporte xet são copiados no lado do servidor e não emitem eventos). Consulte [copyFolder](modules#copyfolder) para as semânticas.

#### Parâmetros[[copyfolderiter.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `destination`: `Omit`\<[`CopyDestination`](interfaces/CopyDestination), ``"path"``\> & \{ `path?`: `string`  } ; `source`: `Omit`\<[`CopySource`](interfaces/CopySource), ``"path"``\> & \{ `path?`: `string`  }  } & `SharedParams` |

#### Retorna[[copyfolderiter.returns]]

`AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\>

#### Definido em[[copyfolderiter.defined-in]]

[packages/hub/src/lib/copy-files.ts:297](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L297)

___

### countCommits

▸ **countCommits**(`params`): `Promise`\<`number`\>

#### Parâmetros[[countcommits.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[countcommits.returns]]

`Promise`\<`number`\>

#### Definido em[[countcommits.defined-in]]

[packages/hub/src/lib/count-commits.ts:8](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/count-commits.ts#L8)

___

### createBranch

▸ **createBranch**(`params`): `Promise`\<`void`\>

#### Parâmetros[[createbranch.parameters]]

| Nome | Tipo | Descrição |
| :------ | :------ | :------ |
| `params` | `Object` | - |
| `params.accessToken?` | `string` | - |
| `params.branch` | `string` | O nome do branch a ser criado |
| `params.empty?` | `boolean` | Use isso para criar um branch vazio, sem commits. |
| `params.fetch?` | (`input`: `RequestInfo` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> | [Referência do MDN](https://developer.mozilla.org/docs/Web/API/Window/fetch) |
| `params.hubUrl?` | `string` | - |
| `params.overwrite?` | `boolean` | Use isso para sobrescrever o branch, caso ele já exista. Se você especificar apenas `overwrite` e nenhum `revision`/`empty`, e o branch já existir, a operação será um no-op. |
| `params.repo` | [`RepoDesignation`](modules#repodesignation) | - |
| `params.revision?` | `string` | Revisão a partir da qual criar o branch. O padrão é o branch padrão. Use empty: true para criar um branch vazio. |

#### Retorna[[createbranch.returns]]

`Promise`\<`void`\>

#### Definido em[[createbranch.defined-in]]

[packages/hub/src/lib/create-branch.ts:7](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/create-branch.ts#L7)

___

### createCollection

▸ **createCollection**(`params`): `Promise`\<\{ `slug`: `string`  }\>

#### Parâmetros[[createcollection.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `collection`: `ApiCreateCollectionPayload` ; `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[createcollection.returns]]

`Promise`\<\{ `slug`: `string`  }\>

#### Definido em[[createcollection.defined-in]]

[packages/hub/src/lib/create-collection.ts:8](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/create-collection.ts#L8)

___

### createRepo

▸ **createRepo**(`params`): `Promise`\<\{ `id`: `string` ; `repoUrl`: `string`  }\>

#### Parâmetros[[createrepo.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `files?`: \{ `content`: `ArrayBuffer` \| `Blob` ; `path`: `string`  }[] ; `hardware?`: SpaceHardwareFlavor \| undefined ; `hubUrl?`: `string` ; `license?`: `string` ; `private?`: `boolean` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `resourceGroupId?`: `string` ; `sdk?`: SpaceSdk \| undefined ; `visibility?`: ``"public"`` \| ``"private"`` \| ``"protected"``  } & `CredentialsParams` |

#### Retorna[[createrepo.returns]]

`Promise`\<\{ `id`: `string` ; `repoUrl`: `string`  }\>

#### Definido em[[createrepo.defined-in]]

[packages/hub/src/lib/create-repo.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/create-repo.ts#L10)

___

### createScheduledJob

▸ **createScheduledJob**(`params`): `Promise`\<`ApiScheduledJob`\>

Crie um job agendado.

#### Parâmetros[[createscheduledjob.parameters]]

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

#### Retorna[[createscheduledjob.returns]]

`Promise`\<`ApiScheduledJob`\>

#### Definido em[[createscheduledjob.defined-in]]

[packages/hub/src/lib/jobs/create-scheduled-job.ts:12](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/create-scheduled-job.ts#L12)

___

### datasetInfo

▸ **datasetInfo**\<`T`\>(`params`): `Promise`\<[`DatasetEntry`](interfaces/DatasetEntry) & `Pick`\<`ApiDatasetInfo`, `T`\>\>

#### Parâmetros de tipo[[datasetinfo.type-parameters]]

| Nome | Tipo |
| :------ | :------ |
| `T` | extends ``"author"`` \| ``"cardData"`` \| ``"disabled"`` \| ``"gitalyUid"`` \| ``"createdAt"`` \| ``"tags"`` \| ``"paperswithcode_id"`` \| ``"sha"`` \| ``"citation"`` \| ``"description"`` \| ``"downloadsAllTime"`` = `never` |

#### Parâmetros[[datasetinfo.parameters]]

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

#### Retorna[[datasetinfo.returns]]

`Promise`\<[`DatasetEntry`](interfaces/DatasetEntry) & `Pick`\<`ApiDatasetInfo`, `T`\>\>

#### Definido em[[datasetinfo.defined-in]]

[packages/hub/src/lib/dataset-info.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/dataset-info.ts#L10)

___

### deleteBranch

▸ **deleteBranch**(`params`): `Promise`\<`void`\>

#### Parâmetros[[deletebranch.parameters]]

| Nome | Tipo | Descrição |
| :------ | :------ | :------ |
| `params` | `Object` | - |
| `params.accessToken?` | `string` | - |
| `params.branch` | `string` | O nome do branch a ser excluído |
| `params.fetch?` | (`input`: `RequestInfo` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> | [Referência do MDN](https://developer.mozilla.org/docs/Web/API/Window/fetch) |
| `params.hubUrl?` | `string` | - |
| `params.repo` | [`RepoDesignation`](modules#repodesignation) | - |

#### Retorna[[deletebranch.returns]]

`Promise`\<`void`\>

#### Definido em[[deletebranch.defined-in]]

[packages/hub/src/lib/delete-branch.ts:7](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/delete-branch.ts#L7)

___

### deleteCollection

▸ **deleteCollection**(`params`): `Promise`\<`void`\>

#### Parâmetros[[deletecollection.parameters]]

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

#### Retorna[[deletecollection.returns]]

`Promise`\<`void`\>

#### Definido em[[deletecollection.defined-in]]

[packages/hub/src/lib/delete-collection.ts:7](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/delete-collection.ts#L7)

___

### deleteFile

▸ **deleteFile**(`params`): `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Parâmetros[[deletefile.parameters]]

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

#### Retorna[[deletefile.returns]]

`Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Definido em[[deletefile.defined-in]]

[packages/hub/src/lib/delete-file.ts:5](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/delete-file.ts#L5)

___

### deleteFiles

▸ **deleteFiles**(`params`): `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Parâmetros[[deletefiles.parameters]]

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

#### Retorna[[deletefiles.returns]]

`Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Definido em[[deletefiles.defined-in]]

[packages/hub/src/lib/delete-files.ts:5](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/delete-files.ts#L5)

___

### deleteRepo

▸ **deleteRepo**(`params`): `Promise`\<`void`\>

#### Parâmetros[[deleterepo.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation)  } & `CredentialsParams` |

#### Retorna[[deleterepo.returns]]

`Promise`\<`void`\>

#### Definido em[[deleterepo.defined-in]]

[packages/hub/src/lib/delete-repo.ts:8](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/delete-repo.ts#L8)

___

### deleteScheduledJob

▸ **deleteScheduledJob**(`params`): `Promise`\<`void`\>

Excluir um agendamento de trabalho.

#### Parâmetros[[deletescheduledjob.parameters]]

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

#### Retorna[[deletescheduledjob.returns]]

`Promise`\<`void`\>

#### Definido em[[deletescheduledjob.defined-in]]

[packages/hub/src/lib/jobs/delete-scheduled-job.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/delete-scheduled-job.ts#L10)

___

### downloadFile

▸ **downloadFile**(`params`): `Promise`\<`Blob` \| ``null``\>

#### Parâmetros[[downloadfile.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `downloadInfo?`: [`FileDownloadInfoOutput`](interfaces/FileDownloadInfoOutput) ; `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `parallelDownloads?`: `boolean` \| [`ParallelDownloadOptions`](interfaces/ParallelDownloadOptions) ; `path`: `string` ; `raw?`: `boolean` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string` ; `xet?`: `boolean` \| \{ `readToken`: [`XetReadToken`](interfaces/XetReadToken)  }  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[downloadfile.returns]]

`Promise`\<`Blob` \| ``null``\>

null quando o arquivo não existe

#### Definido em[[downloadfile.defined-in]]

[packages/hub/src/lib/download-file.ts:13](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/download-file.ts#L13)

___

### downloadFileToCacheDir

▸ **downloadFileToCacheDir**(`params`): `Promise`\<`string`\>

Baixe um arquivo específico, caso ele ainda não esteja presente no cache local.

#### Parâmetros[[downloadfiletocachedir.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `cacheDir?`: `string` ; `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `path`: `string` ; `raw?`: `boolean` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[downloadfiletocachedir.returns]]

`Promise`\<`string`\>

o link simbólico para o objeto blob

#### Definido em[[downloadfiletocachedir.defined-in]]

[packages/hub/src/lib/download-file-to-cache-dir.ts:46](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/download-file-to-cache-dir.ts#L46)

___

### duplicateJob

▸ **duplicateJob**(`params`): `Promise`\<`ApiJob`\>

Duplicar um job (reexecutar com a mesma especificação).

#### Parâmetros[[duplicatejob.parameters]]

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

#### Retorna[[duplicatejob.returns]]

`Promise`\<`ApiJob`\>

#### Definido em[[duplicatejob.defined-in]]

[packages/hub/src/lib/jobs/duplicate-job.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/duplicate-job.ts#L11)

___

### encodeShardFilename

▸ **encodeShardFilename**(`filename`): `string`

Defesa em profundidade: a URL de download é construída por interpolação de strings, portanto, codifique cada segmento de caminho do nome do arquivo (já validado) em vez de confiar que ele é seguro para URLs.

#### Parâmetros[[encodeshardfilename.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `filename` | `string` |

#### Retorna[[encodeshardfilename.returns]]

`string`

#### Definido em[[encodeshardfilename.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:570](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L570)

___

### fileDownloadInfo

▸ **fileDownloadInfo**(`params`): `Promise`\<[`FileDownloadInfoOutput`](interfaces/FileDownloadInfoOutput) \| ``null``\>

#### Parâmetros[[filedownloadinfo.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `noContentDisposition?`: `boolean` ; `path`: `string` ; `raw?`: `boolean` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[filedownloadinfo.returns]]

`Promise`\<[`FileDownloadInfoOutput`](interfaces/FileDownloadInfoOutput) \| ``null``\>

null quando o arquivo não existe

#### Definido em[[filedownloadinfo.defined-in]]

[packages/hub/src/lib/file-download-info.ts:28](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/file-download-info.ts#L28)

___

### fileExists

▸ **fileExists**(`params`): `Promise`\<`boolean`\>

#### Parâmetros[[fileexists.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `path`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[fileexists.returns]]

`Promise`\<`boolean`\>

#### Definido em[[fileexists.defined-in]]

[packages/hub/src/lib/file-exists.ts:8](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/file-exists.ts#L8)

___

### getBlobStat

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

#### Parâmetros[[getblobstat.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `blobPath` | `string` |
| `blobStats` | `Map`\<`string`, `Stats`\> |

#### Retorna[[getblobstat.returns]]

`Promise`\<`Stats`\>

#### Definido em[[getblobstat.defined-in]]

[packages/hub/src/lib/cache-management.ts:254](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L254)

___

### getHFHubCachePath

▸ **getHFHubCachePath**(): `string`

#### Retorna[[gethfhubcachepath.returns]]

`string`

#### Definido em[[gethfhubcachepath.defined-in]]

[packages/hub/src/lib/cache-management.ts:19](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L19)

___

### getJob

▸ **getJob**(`params`): `Promise`\<`ApiJob`\>

Obtenha um trabalho específico pelo ID.

#### Parâmetros[[getjob.parameters]]

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

#### Retorna[[getjob.returns]]

`Promise`\<`ApiJob`\>

#### Definido em[[getjob.defined-in]]

[packages/hub/src/lib/jobs/get-job.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/get-job.ts#L11)

___

### getQuantizationMultiplier

▸ **getQuantizationMultiplier**(`tensorName`, `dtype`, `quantConfig?`, `expertDtype?`, `mlxQuantizedModules?`): `number`

Obtém o multiplicador de parâmetros para um tensor quantizado com base no método de quantização.

Pode ser fracionário — veja `packingFactor`.

#### Parâmetros[[getquantizationmultiplier.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `tensorName` | `string` |
| `dtype` | [`Dtype`](modules#dtype) |
| `quantConfig?` | [`QuantizationConfig`](interfaces/QuantizationConfig) |
| `expertDtype?` | `string` |
| `mlxQuantizedModules?` | `ReadonlySet`\<`string`\> |

#### Retorna[[getquantizationmultiplier.returns]]

`number`

#### Definido em[[getquantizationmultiplier.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:1259](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L1259)

___

### getRepoFolderName

▸ **getRepoFolderName**(`«destructured»`): `string`

#### Parâmetros[[getrepofoldername.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `«destructured»` | [`RepoId`](interfaces/RepoId) |

#### Retorna[[getrepofoldername.returns]]

`string`

#### Definido em[[getrepofoldername.defined-in]]

[packages/hub/src/lib/cache-management.ts:27](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L27)

___

### getScheduledJob

▸ **getScheduledJob**(`params`): `Promise`\<`ApiScheduledJob`\>

Obtenha um trabalho agendado específico pelo ID.

#### Parâmetros[[getscheduledjob.parameters]]

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

#### Retorna[[getscheduledjob.returns]]

`Promise`\<`ApiScheduledJob`\>

#### Definido em[[getscheduledjob.defined-in]]

[packages/hub/src/lib/jobs/get-scheduled-job.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/get-scheduled-job.ts#L11)

___

### globMatch

▸ **globMatch**(`pattern`, `str`): `boolean`

Correspondência de glob sem RegExp: divide o padrão em `*` e verifica que cada segmento literal aparece em ordem dentro de `str`. Evita o uso de RegExp por completo (sem risco de ReDoS, sem SyntaxError causado por padrões controlados por um atacante em config.json).

#### Parâmetros[[globmatch.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `pattern` | `string` |
| `str` | `string` |

#### Retorna[[globmatch.returns]]

`boolean`

#### Definido em[[globmatch.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:1153](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L1153)

___

### isQuantizedTensor

▸ **isQuantizedTensor**(`tensorName`, `quantConfig?`, `mlxQuantizedModules?`): `boolean`

Determina se um tensor está quantizado com base na configuração de quantização e no nome do tensor.

O transformers do Python usa correspondência de substrings simples para `modules_to_not_convert`, portanto, nomes simples como `"lm_head"` devem corresponder a `"model.lm_head.weight"`. Quando o padrão contém um `*`, recorremos à correspondência glob adequada para maior flexibilidade.

#### Parâmetros[[isquantizedtensor.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `tensorName` | `string` |
| `quantConfig?` | [`QuantizationConfig`](interfaces/QuantizationConfig) |
| `mlxQuantizedModules?` | `ReadonlySet`\<`string`\> |

#### Retorna[[isquantizedtensor.returns]]

`boolean`

#### Definido em[[isquantizedtensor.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:1189](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L1189)

___

### listCollections

▸ **listCollections**(`params?`): `AsyncGenerator`\<`ApiCollectionInfo`\>

#### Parâmetros[[listcollections.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params?` | \{ search?: \{ owner?: string[] \| undefined; item?: string[] \| undefined; q?: string \| undefined; } \| undefined; sort?: "lastModified" \| "trending" \| "upvotes" \| undefined; limit?: number \| undefined; hubUrl?: string \| undefined; fetch?: \{ ...; } \| undefined; } & Partial\<...\> |

#### Retorna[[listcollections.returns]]

`AsyncGenerator`\<`ApiCollectionInfo`\>

#### Definido em[[listcollections.defined-in]]

[packages/hub/src/lib/list-collections.ts:13](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-collections.ts#L13)

___

### listCommits

▸ **listCommits**(`params`): `AsyncGenerator`\<[`CommitData`](interfaces/CommitData)\>

#### Parâmetros[[listcommits.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `batchSize?`: `number` ; `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[listcommits.returns]]

`AsyncGenerator`\<[`CommitData`](interfaces/CommitData)\>

#### Definido em[[listcommits.defined-in]]

[packages/hub/src/lib/list-commits.ts:18](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-commits.ts#L18)

___

### listDatasets

▸ **listDatasets**\<`T`\>(`params?`): `AsyncGenerator`\<[`DatasetEntry`](interfaces/DatasetEntry) & `Pick`\<`ApiDatasetInfo`, `T`\>\>

#### Parâmetros de tipo[[listdatasets.type-parameters]]

| Nome | Tipo |
| :------ | :------ |
| `T` | extends ``"author"`` \| ``"cardData"`` \| ``"disabled"`` \| ``"gitalyUid"`` \| ``"createdAt"`` \| ``"tags"`` \| ``"paperswithcode_id"`` \| ``"sha"`` \| ``"citation"`` \| ``"description"`` \| ``"downloadsAllTime"`` = `never` |

#### Parâmetros[[listdatasets.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params?` | \{ search?: \{ query?: string \| undefined; owner?: string \| undefined; tags?: string[] \| undefined; } \| undefined; hubUrl?: string \| undefined; additionalFields?: T[] \| undefined; limit?: number \| undefined; sort?: "id" \| ... 8 more ... \| undefined; fetch?: \{ ...; } \| undefined; } & Partial\<...\> |

#### Retorna[[listdatasets.returns]]

`AsyncGenerator`\<[`DatasetEntry`](interfaces/DatasetEntry) & `Pick`\<`ApiDatasetInfo`, `T`\>\>

#### Definido em[[listdatasets.defined-in]]

[packages/hub/src/lib/list-datasets.ts:48](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-datasets.ts#L48)

___

### listFiles

▸ **listFiles**(`params`): `AsyncGenerator`\<[`ListFileEntry`](interfaces/ListFileEntry)\>

Liste os arquivos em uma pasta. Para listar TODOS os arquivos no diretório, chame-o com params.recursive definido como `true`.

#### Parâmetros[[listfiles.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `expand?`: `boolean` ; `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `path?`: `string` ; `recursive?`: `boolean` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[listfiles.returns]]

`AsyncGenerator`\<[`ListFileEntry`](interfaces/ListFileEntry)\>

#### Definido em[[listfiles.defined-in]]

[packages/hub/src/lib/list-files.ts:54](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L54)

___

### listJobHardware

▸ **listJobHardware**(`params?`): `Promise`\<`ApiJobHardware`[]\>

Obtenha a lista de hardware disponível para os jobs. Este endpoint é público e não requer autenticação, mas a autenticação é opcional.

#### Parâmetros[[listjobhardware.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params?` | \{ hubUrl?: string \| undefined; fetch?: \{ (input: RequestInfo \| URL, init?: RequestInit \| undefined): Promise\; (input: string \| ... 1 more ... \| URL, init?: RequestInit \| undefined): Promise\<...\>; } \| undefined; } & Partial\<...\> |

#### Retorna[[listjobhardware.returns]]

`Promise`\<`ApiJobHardware`[]\>

#### Definido em[[listjobhardware.defined-in]]

[packages/hub/src/lib/jobs/list-job-hardware.ts:12](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/list-job-hardware.ts#L12)

___

### listJobs

▸ **listJobs**(`params`): `Promise`\<`ApiJob`[]\>

Liste os trabalhos de um namespace (usuário ou organização).

#### Parâmetros[[listjobs.parameters]]

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

#### Retorna[[listjobs.returns]]

`Promise`\<`ApiJob`[]\>

#### Definido em[[listjobs.defined-in]]

[packages/hub/src/lib/jobs/list-jobs.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/list-jobs.ts#L11)

___

### listModels

▸ **listModels**\<`T`\>(`params?`): `AsyncGenerator`\<[`ModelEntry`](interfaces/ModelEntry) & [`ResolveModelAdditionalFields`](modules#resolvemodeladditionalfields)\<`T`\>\>

#### Parâmetros de tipo[[listmodels.type-parameters]]

| Nome | Tipo |
| :------ | :------ |
| `T` | estende [`ModelAdditionalField`](modules#modeladditionalfield) = `never` |

#### Parâmetros[[listmodels.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params?` | \{ search?: \{ query?: string \| undefined; owner?: string \| undefined; task?: "other" \| "text-classification" \| "token-classification" \| "table-question-answering" \| "question-answering" \| ... 52 more ... \| undefined; tags?: string[] \| undefined; inferenceProviders?: string[] \| undefined; apps?: string[] \| undefined; ... |

#### Retorna[[listmodels.returns]]

`AsyncGenerator`\<[`ModelEntry`](interfaces/ModelEntry) & [`ResolveModelAdditionalFields`](modules#resolvemodeladditionalfields)\<`T`\>\>

#### Definido em[[listmodels.defined-in]]

[packages/hub/src/lib/list-models.ts:69](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L69)

___

### listScheduledJobs

▸ **listScheduledJobs**(`params`): `Promise`\<`ApiScheduledJob`[]\>

Liste os trabalhos agendados para um namespace.

#### Parâmetros[[listscheduledjobs.parameters]]

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

#### Retorna[[listscheduledjobs.returns]]

`Promise`\<`ApiScheduledJob`[]\>

#### Definido em[[listscheduledjobs.defined-in]]

[packages/hub/src/lib/jobs/list-scheduled-jobs.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/list-scheduled-jobs.ts#L11)

___

### listSpaces

▸ **listSpaces**\<`T`\>(`params?`): `AsyncGenerator`\<[`SpaceEntry`](interfaces/SpaceEntry) & `Pick`\<`ApiSpaceInfo`, `T`\>\>

#### Parâmetros de tipo[[listspaces.type-parameters]]

| Nome | Tipo |
| :------ | :------ |
| `T` | extends ``"models"`` \| ``"datasets"`` \| ``"author"`` \| ``"cardData"`` \| ``"disabled"`` \| ``"gitalyUid"`` \| ``"createdAt"`` \| ``"tags"`` \| ``"sha"`` \| ``"subdomain"`` \| ``"runtime"`` = `never` |

#### Parâmetros[[listspaces.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params?` | \{ search?: \{ query?: string \| undefined; owner?: string \| undefined; tags?: string[] \| undefined; } \| undefined; hubUrl?: string \| undefined; fetch?: \{ (input: RequestInfo \| URL, init?: RequestInit \| undefined): Promise\<...\>; (input: string \| ... 1 more ... \| URL, init?: RequestInit \| undefined): Promise\<...\>; } \| u... |

#### Retorna[[listspaces.returns]]

`AsyncGenerator`\<[`SpaceEntry`](interfaces/SpaceEntry) & `Pick`\<`ApiSpaceInfo`, `T`\>\>

#### Definido em[[listspaces.defined-in]]

[packages/hub/src/lib/list-spaces.ts:45](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-spaces.ts#L45)

___

### matchesCompressedTensorsTarget

▸ **matchesCompressedTensorsTarget**(`target`, `moduleName`): `boolean`

Corresponde a um nome de módulo a um alvo do compressed-tensors.

Os alvos são nomes exatos de módulos, nomes de classes (por exemplo, `"Linear"`, que não podemos resolver a partir dos nomes de tensores e, portanto, ignoramos) ou expressões regulares do Python prefixadas com `re:`. Para evitar a avaliação de RegExp controlado por um atacante a partir do config.json (ReDoS, SyntaxError — veja globMatch), traduzimos o subconjunto comum de expressões regulares (`.*` curinga, âncoras `^`/`$`, escapes `\.`) para globMatch e tratamos alvos que usam qualquer outra sintaxe de expressão regular como não correspondentes.

#### Parâmetros[[matchescompressedtensorstarget.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `target` | `string` |
| `moduleName` | `string` |

#### Retorna[[matchescompressedtensorstarget.returns]]

`boolean`

#### Definido em[[matchescompressedtensorstarget.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:1231](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L1231)

___

### modelInfo

▸ **modelInfo**\<`T`\>(`params`): `Promise`\<[`ModelEntry`](interfaces/ModelEntry) & [`ResolveModelAdditionalFields`](modules#resolvemodeladditionalfields)\<`T`\>\>

#### Parâmetros de tipo[[modelinfo.type-parameters]]

| Nome | Tipo |
| :------ | :------ |
| `T` | estende [`ModelAdditionalField`](modules#modeladditionalfield) = `never` |

#### Parâmetros[[modelinfo.parameters]]

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

#### Retorna[[modelinfo.returns]]

`Promise`\<[`ModelEntry`](interfaces/ModelEntry) & [`ResolveModelAdditionalFields`](modules#resolvemodeladditionalfields)\<`T`\>\>

#### Definido em[[modelinfo.defined-in]]

[packages/hub/src/lib/model-info.ts:17](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/model-info.ts#L17)

___

### oauthHandleRedirect

▸ **oauthHandleRedirect**(`opts?`): `Promise`\<[`OAuthResult`](interfaces/OAuthResult)\>

Para chamar depois que o provedor de OAuth redireciona de volta para o aplicativo.

Há também uma função auxiliar [oauthHandleRedirectIfPresent](modules#oauthhandleredirectifpresent), que chamará `oauthHandleRedirect` se a URL contiver um código oauth nos parâmetros de consulta e retornará `false` caso contrário.

#### Parâmetros[[oauthhandleredirect.parameters]]

| Nome | Tipo | Descrição |
| :------ | :------ | :------ |
| `opts?` | `Object` | - |
| `opts.codeVerifier?` | `string` | codeVerifier gerado por oauthLoginUrl **`Default`** ```ts localStorage.getItem("huggingface.co:oauth:code_verifier") ``` |
| `opts.hubUrl?` | `string` | A URL do hub. O padrão é [HUB_URL](modules#hub_url). |
| `opts.nonce?` | `string` | nonce gerado por oauthLoginUrl **`Default`** ```ts localStorage.getItem("huggingface.co:oauth:nonce") ``` |
| `opts.redirectedUrl?` | `string` | A URL a ser analisada. **`Default`** ```ts window.location.href ``` |

#### Retorna[[oauthhandleredirect.returns]]

`Promise`\<[`OAuthResult`](interfaces/OAuthResult)\>

#### Definido em[[oauthhandleredirect.defined-in]]

[packages/hub/src/lib/oauth-handle-redirect.ts:123](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/oauth-handle-redirect.ts#L123)

___

### oauthHandleRedirectIfPresent

▸ **oauthHandleRedirectIfPresent**(`opts?`): `Promise`\<[`OAuthResult`](interfaces/OAuthResult) \| ``false``\>

Para chamar depois que o provedor de OAuth redireciona de volta para o aplicativo.

Retorna false se a URL não contiver um código oauth nos parâmetros de consulta; caso contrário, chama [oauthHandleRedirect](modules#oauthhandleredirect).

Dependendo do seu aplicativo, você pode querer chamar [oauthHandleRedirect](modules#oauthhandleredirect) diretamente em vez disso.

#### Parâmetros[[oauthhandleredirectifpresent.parameters]]

| Nome | Tipo | Descrição |
| :------ | :------ | :------ |
| `opts?` | `Object` | - |
| `opts.codeVerifier?` | `string` | codeVerifier gerado por oauthLoginUrl **`Default`** ```ts localStorage.getItem("huggingface.co:oauth:code_verifier") ``` |
| `opts.hubUrl?` | `string` | A URL do hub. O padrão é [HUB_URL](modules#hub_url). |
| `opts.nonce?` | `string` | nonce gerado por oauthLoginUrl **`Default`** ```ts localStorage.getItem("huggingface.co:oauth:nonce") ``` |
| `opts.redirectedUrl?` | `string` | A URL a ser analisada. **`Default`** ```ts window.location.href ``` |

#### Retorna[[oauthhandleredirectifpresent.returns]]

`Promise`\<[`OAuthResult`](interfaces/OAuthResult) \| ``false``\>

#### Definido em[[oauthhandleredirectifpresent.defined-in]]

[packages/hub/src/lib/oauth-handle-redirect.ts:293](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/oauth-handle-redirect.ts#L293)

___

### oauthLoginUrl

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

Use "Sign in with Hub" para autenticar um usuário e obter as informações do usuário oauth / token de acesso.

Retorna uma URL para redirecionamento. Após o usuário ser redirecionado de volta para o seu aplicativo, chame `oauthHandleRedirect` para obter as informações do usuário oauth / token de acesso.

Quando chamado de dentro de um Space estático com OAuth habilitado, ele carregará a configuração do space; caso contrário, você precisa especificar pelo menos o ID do cliente do seu aplicativo OAuth.

#### Parâmetros[[oauthloginurl.parameters]]

| Nome | Tipo | Descrição |
| :------ | :------ | :------ |
| `opts?` | `Object` | - |
| `opts.clientId?` | `string` | ID do cliente OAuth. Para Spaces estáticos, você pode omitir isso e ele será carregado da configuração do Space, desde que `hf_oauth: true` esteja presente nos metadados do README.md. Para outros Spaces, ele está disponível para o backend na variável de ambiente OAUTH_CLIENT_ID, desde que `hf_oauth: true` esteja presente nos metadados do README.md. Você também pode criar um Aplicativo de Desenvolvedor em https://huggingface.co/settings/connected-applications e usar seu ID de cliente. |
| `opts.hubUrl?` | `string` | - |
| `opts.localStorage?` | `Object` | Se fornecido, será preenchido com o verificador de código e o nonce usados para o fluxo OAuth, em vez de usar o localStorage. Ao chamar `oauthHandleRedirectIfPresent` ou `oauthHandleRedirect`, você precisará fornecer os mesmos valores. |
| `opts.localStorage.codeVerifier?` | `string` | - |
| `opts.localStorage.nonce?` | `string` | - |
| `opts.redirectUrl?` | `string` | URI de redirecionamento, padrão é a URL atual. Para Spaces, qualquer URL dentro do Space é permitida. Para Aplicações de Desenvolvedor, você pode adicionar qualquer URL que desejar à lista de URIs de redirecionamento permitidas em https://huggingface.co/settings/connected-applications. |
| `opts.scopes?` | `string` | Escopo OAuth, uma lista de escopos separados por espaços. Para Spaces estáticos, você pode omitir isso e ele será carregado da configuração do Space, desde que `hf_oauth: true` esteja presente nos metadados do README.md. Para outros Spaces, ele fica disponível para o backend na variável de ambiente OAUTH_SCOPES, desde que `hf_oauth: true` esteja presente nos metadados do README.md. O padrão é "openid profile". Você também pode criar um Aplicativo de Desenvolvedor em https://huggingface.co/settings/connected-applications e usar seus escopos. Consulte https://huggingface.co/docs/hub/oauth para uma lista dos escopos disponíveis. |
| `opts.state?` | `string` | Estado a ser passado ao provedor OAuth, que será retornado na chamada para `oauthLogin` após o redirecionamento. |

#### Retorna[[oauthloginurl.returns]]

`Promise`\<`string`\>

**`Example`**

```ts
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);
```

(Em teoria, esta função poderia ser usada para autenticar um usuário em qualquer provedor OAuth que suporte PKCE e OpenID Connect, alterando `hubUrl`, mas atualmente ela é testada apenas com o Hugging Face Hub.)

#### Definido em[[oauthloginurl.defined-in]]

[packages/hub/src/lib/oauth-login-url.ts:31](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/oauth-login-url.ts#L31)

___

### parseRepoType

▸ **parseRepoType**(`type`): [`RepoType`](modules#repotype)

#### Parâmetros[[parserepotype.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `type` | `string` |

#### Retorna[[parserepotype.returns]]

[`RepoType`](modules#repotype)

#### Definido em[[parserepotype.defined-in]]

[packages/hub/src/lib/cache-management.ts:264](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L264)

___

### parseSafetensorsMetadata

▸ **parseSafetensorsMetadata**(`params`): `Promise`\<`SetRequired`\<[`SafetensorsParseFromRepo`](modules#safetensorsparsefromrepo), ``"parameterCount"``\>\>

Analise model.safetensors.index.json ou model.safetensors de um modelo hospedado no Hugging Face usando solicitações de intervalo inteligentes para extrair seus metadados.

#### Parâmetros[[parsesafetensorsmetadata.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `computeParametersCount`: ``true`` ; `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `library?`: `string` ; `path?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string` ; `useSafetensorsMetadataEndpoint?`: `boolean`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[parsesafetensorsmetadata.returns]]

`Promise`\<`SetRequired`\<[`SafetensorsParseFromRepo`](modules#safetensorsparsefromrepo), ``"parameterCount"``\>\>

#### Definido em[[parsesafetensorsmetadata.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:738](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L738)

▸ **parseSafetensorsMetadata**(`params`): `Promise`\<[`SafetensorsParseFromRepo`](modules#safetensorsparsefromrepo)\>

#### Parâmetros[[parsesafetensorsmetadata.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `computeParametersCount?`: `boolean` ; `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `library?`: `string` ; `path?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string` ; `useSafetensorsMetadataEndpoint?`: `boolean`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[parsesafetensorsmetadata.returns]]

`Promise`\<[`SafetensorsParseFromRepo`](modules#safetensorsparsefromrepo)\>

#### Definido em[[parsesafetensorsmetadata.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:775](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L775)

___

### parseSafetensorsShardFilename

▸ **parseSafetensorsShardFilename**(`filename`): [`SafetensorsShardFileInfo`](interfaces/SafetensorsShardFileInfo) \| ``null``

#### Parâmetros[[parsesafetensorsshardfilename.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `filename` | `string` |

#### Retorna[[parsesafetensorsshardfilename.returns]]

[`SafetensorsShardFileInfo`](interfaces/SafetensorsShardFileInfo) \| ``null``

#### Definido em[[parsesafetensorsshardfilename.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:36](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L36)

___

### parseTotalParameters

▸ **parseTotalParameters**(`value`, `computedTotal?`): `number` \| `undefined`

Lê o atalho `total_parameters` dos metadados do cabeçalho/índice. É auto-declarado e o Hub o exibe literalmente, ignorando a validação do cabeçalho acima — portanto, limite-o pela contagem calculada quando houver uma (uma operação sem efeito para arquivos bem formados, onde os dois valores coincidem).

#### Parâmetros[[parsetotalparameters.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `value` | `undefined` \| `string` \| `number` |
| `computedTotal?` | `number` |

#### Retorna[[parsetotalparameters.returns]]

`number` \| `undefined`

#### Definido em[[parsetotalparameters.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:699](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L699)

___

### pathsInfo

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

#### Parâmetros[[pathsinfo.parameters]]

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

#### Retorna[[pathsinfo.returns]]

`Promise`\<[`PathInfo`](interfaces/PathInfo) & \{ `lastCommit`: [`CommitInfo`](interfaces/CommitInfo) ; `securityFileStatus`: [`SecurityFileStatus`](interfaces/SecurityFileStatus)  }[]\>

#### Definido em[[pathsinfo.defined-in]]

[packages/hub/src/lib/paths-info.ts:52](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/paths-info.ts#L52)

▸ **pathsInfo**(`params`): `Promise`\<[`PathInfo`](interfaces/PathInfo)[]\>

#### Parâmetros[[pathsinfo.parameters]]

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

#### Retorna[[pathsinfo.returns]]

`Promise`\<[`PathInfo`](interfaces/PathInfo)[]\>

#### Definido em[[pathsinfo.defined-in]]

[packages/hub/src/lib/paths-info.ts:65](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/paths-info.ts#L65)

___

### relativeUnderFolder

▸ **relativeUnderFolder**(`filePath`, `folderPath`): `string`

Calcula o caminho de `filePath` relativo a `folderPath`. Usado para mapear caminhos de origem sob uma pasta que está sendo copiada para caminhos de destino sob o novo prefixo.

#### Parâmetros[[relativeunderfolder.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `filePath` | `string` |
| `folderPath` | `string` |

#### Retorna[[relativeunderfolder.returns]]

`string`

#### Definido em[[relativeunderfolder.defined-in]]

[packages/hub/src/lib/copy-files.ts:558](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L558)

___

### repoExists

▸ **repoExists**(`params`): `Promise`\<`boolean`\>

#### Parâmetros[[repoexists.parameters]]

| Nome | Tipo | Descrição |
| :------ | :------ | :------ |
| `params` | `Object` | - |
| `params.accessToken?` | `string` | - |
| `params.fetch?` | (`input`: `RequestInfo` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> | Função de fetch personalizada para usar no lugar da padrão, por exemplo, para usar um proxy ou editar cabeçalhos. |
| `params.hubUrl?` | `string` | - |
| `params.repo` | [`RepoDesignation`](modules#repodesignation) | - |
| `params.revision?` | `string` | Um id de revisão Git opcional, que pode ser um nome de branch, uma tag ou um hash de commit. |

#### Retorna[[repoexists.returns]]

`Promise`\<`boolean`\>

#### Definido em[[repoexists.defined-in]]

[packages/hub/src/lib/repo-exists.ts:7](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/repo-exists.ts#L7)

___

### resumeScheduledJob

▸ **resumeScheduledJob**(`params`): `Promise`\<`void`\>

Retomar um trabalho agendado.

#### Parâmetros[[resumescheduledjob.parameters]]

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

#### Retorna[[resumescheduledjob.returns]]

`Promise`\<`void`\>

#### Definido em[[resumescheduledjob.defined-in]]

[packages/hub/src/lib/jobs/resume-scheduled-job.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/resume-scheduled-job.ts#L10)

___

### runJob

▸ **runJob**(`params`): `Promise`\<`ApiJob`\>

Execute um novo job.

#### Parâmetros[[runjob.parameters]]

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

#### Retorna[[runjob.returns]]

`Promise`\<`ApiJob`\>

#### Definido em[[runjob.defined-in]]

[packages/hub/src/lib/jobs/run-job.ts:13](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/run-job.ts#L13)

___

### runScheduledJob

▸ **runScheduledJob**(`params`): `Promise`\<`ApiJob` \| ``null``\>

Dispare um trabalho agendado para executar imediatamente. Retorna o trabalho que foi disparado, ou null se outra instância já estiver em execução.

#### Parâmetros[[runscheduledjob.parameters]]

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

#### Retorna[[runscheduledjob.returns]]

`Promise`\<`ApiJob` \| ``null``\>

#### Definido em[[runscheduledjob.defined-in]]

[packages/hub/src/lib/jobs/run-scheduled-job.ts:12](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/run-scheduled-job.ts#L12)

___

### scanCacheDir

▸ **scanCacheDir**(`cacheDir?`): `Promise`\<[`HFCacheInfo`](interfaces/HFCacheInfo)\>

#### Parâmetros[[scancachedir.parameters]]

| Nome | Tipo | Valor padrão |
| :------ | :------ | :------ |
| `cacheDir` | `undefined` \| `string` | `undefined` |

#### Retorna[[scancachedir.returns]]

`Promise`\<[`HFCacheInfo`](interfaces/HFCacheInfo)\>

#### Definido em[[scancachedir.defined-in]]

[packages/hub/src/lib/cache-management.ts:72](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L72)

___

### scanCachedRepo

▸ **scanCachedRepo**(`repoPath`): `Promise`\<[`CachedRepoInfo`](interfaces/CachedRepoInfo)\>

#### Parâmetros[[scancachedrepo.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `repoPath` | `string` |

#### Retorna[[scancachedrepo.returns]]

`Promise`\<[`CachedRepoInfo`](interfaces/CachedRepoInfo)\>

#### Definido em[[scancachedrepo.defined-in]]

[packages/hub/src/lib/cache-management.ts:118](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L118)

___

### scanRefsDir

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

#### Parâmetros[[scanrefsdir.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `refsPath` | `string` |
| `refsByHash` | `Map`\<`string`, `string`[]\> |

#### Retorna[[scanrefsdir.returns]]

`Promise`\<`void`\>

#### Definido em[[scanrefsdir.defined-in]]

[packages/hub/src/lib/cache-management.ts:210](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L210)

___

### scanSnapshotDir

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

#### Parâmetros[[scansnapshotdir.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `revisionPath` | `string` |
| `cachedFiles` | [`CachedFileInfo`](interfaces/CachedFileInfo)[] |
| `blobStats` | `Map`\<`string`, `Stats`\> |

#### Retorna[[scansnapshotdir.returns]]

`Promise`\<`void`\>

#### Definido em[[scansnapshotdir.defined-in]]

[packages/hub/src/lib/cache-management.ts:227](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L227)

___

### snapshotDownload

▸ **snapshotDownload**(`params`): `Promise`\<`string`\>

Baixa um repositório inteiro em uma revisão específica no diretório de cache [getHFHubCachePath](modules#gethfhubcachepath). Você pode listar todos os repositórios em cache usando [scanCachedRepo](modules#scancachedrepo)

#### Parâmetros[[snapshotdownload.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `cacheDir?`: `string` ; `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[snapshotdownload.returns]]

`Promise`\<`string`\>

**`Remarks`**

Ele usa internamente [downloadFileToCacheDir](modules#downloadfiletocachedir).

#### Definido em[[snapshotdownload.defined-in]]

[packages/hub/src/lib/snapshot-download.ts:20](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/snapshot-download.ts#L20)

___

### spaceInfo

▸ **spaceInfo**\<`T`\>(`params`): `Promise`\<[`SpaceEntry`](interfaces/SpaceEntry) & `Pick`\<`ApiSpaceInfo`, `T`\>\>

#### Parâmetros de tipo[[spaceinfo.type-parameters]]

| Nome | Tipo |
| :------ | :------ |
| `T` | extends ``"models"`` \| ``"datasets"`` \| ``"author"`` \| ``"cardData"`` \| ``"disabled"`` \| ``"gitalyUid"`` \| ``"createdAt"`` \| ``"tags"`` \| ``"sha"`` \| ``"subdomain"`` \| ``"runtime"`` = `never` |

#### Parâmetros[[spaceinfo.parameters]]

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

#### Retorna[[spaceinfo.returns]]

`Promise`\<[`SpaceEntry`](interfaces/SpaceEntry) & `Pick`\<`ApiSpaceInfo`, `T`\>\>

#### Definido em[[spaceinfo.defined-in]]

[packages/hub/src/lib/space-info.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/space-info.ts#L11)

___

### streamJobEvents

▸ **streamJobEvents**(`params`): `AsyncGenerator`\<`string`, `void`, `unknown`\>

Transmita eventos de jobs usando Server-Sent Events (SSE). Retorna um iterável assíncrono de blocos de eventos.

#### Parâmetros[[streamjobevents.parameters]]

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

#### Retorna[[streamjobevents.returns]]

`AsyncGenerator`\<`string`, `void`, `unknown`\>

#### Definido em[[streamjobevents.defined-in]]

[packages/hub/src/lib/jobs/stream-job-events.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/stream-job-events.ts#L11)

___

### streamJobLogs

▸ **streamJobLogs**(`params`): `AsyncGenerator`\<\{ `message`: `string` ; `timestamp`: `Date`  }, `void`, `unknown`\>

Transmita os logs do job usando Server-Sent Events (SSE). Retorna um iterável assíncrono de fragmentos de log.

#### Parâmetros[[streamjoblogs.parameters]]

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

#### Retorna[[streamjoblogs.returns]]

`AsyncGenerator`\<\{ `message`: `string` ; `timestamp`: `Date`  }, `void`, `unknown`\>

#### Definido em[[streamjoblogs.defined-in]]

[packages/hub/src/lib/jobs/stream-job-logs.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/stream-job-logs.ts#L11)

___

### streamJobMetrics

▸ **streamJobMetrics**(`params`): `AsyncGenerator`\<`string`, `void`, `unknown`\>

Transmita métricas de jobs de streaming usando Server-Sent Events (SSE). Retorna um iterável assíncrono de blocos de métricas.

#### Parâmetros[[streamjobmetrics.parameters]]

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

#### Retorna[[streamjobmetrics.returns]]

`AsyncGenerator`\<`string`, `void`, `unknown`\>

#### Definido em[[streamjobmetrics.defined-in]]

[packages/hub/src/lib/jobs/stream-job-metrics.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/stream-job-metrics.ts#L11)

___

### streamJson

▸ **streamJson**(`source`, `options?`): `AsyncGenerator`\<[`JsonStreamEvent`](modules#jsonstreamevent), `void`, `undefined`\>

#### Parâmetros[[streamjson.parameters]]

| Nome | Tipo | Descrição |
| :------ | :------ | :------ |
| `source` | `ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\> \| `AsyncIterable`\<`Uint8Array`\<`ArrayBufferLike`\>, `any`, `any`\> | - |
| `options?` | `Object` | - |
| `options.maxDepth?` | `number` | Profundidade máxima de aninhamento de objetos/arrays. **`Default`** ```ts 1_000 ``` |
| `options.maxTokenLength?` | `number` | Comprimento máximo, em caracteres, de um único token de string / número. **`Default`** ```ts 16_000_000 ``` |

#### Retorna[[streamjson.returns]]

`AsyncGenerator`\<[`JsonStreamEvent`](modules#jsonstreamevent), `void`, `undefined`\>

#### Definido em[[streamjson.defined-in]]

[packages/hub/src/utils/streamJson.ts:123](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/utils/streamJson.ts#L123)

___

### suspendScheduledJob

▸ **suspendScheduledJob**(`params`): `Promise`\<`void`\>

Suspend (pausa) um agendamento de trabalho.

#### Parâmetros[[suspendscheduledjob.parameters]]

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

#### Retorna[[suspendscheduledjob.returns]]

`Promise`\<`void`\>

#### Definido em[[suspendscheduledjob.defined-in]]

[packages/hub/src/lib/jobs/suspend-scheduled-job.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/suspend-scheduled-job.ts#L10)

___

### uploadFile

▸ **uploadFile**(`params`): `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Parâmetros[[uploadfile.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `abortSignal?`: `AbortSignal` ; `branch?`: `string` ; `commitDescription?`: `string` ; `commitTitle?`: `string` ; `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `file`: `URL` \| [`CommitEditFileParams`](interfaces/CommitEditFileParams) \| `File` \| \{ `content`: [`ContentSource`](modules#contentsource) ; `path`: `string`  } ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `parentCommit?`: `string` ; `rangeEditCache?`: [`RangeEditCache`](modules#rangeeditcache) ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `useWebWorkers?`: `boolean` \| \{ `minSize?`: `number` ; `poolSize?`: `number`  } ; `useXet?`: `boolean`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[uploadfile.returns]]

`Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Definido em[[uploadfile.defined-in]]

[packages/hub/src/lib/upload-file.ts:39](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/upload-file.ts#L39)

___

### uploadFiles

▸ **uploadFiles**(`params`): `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Parâmetros[[uploadfiles.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `abortSignal?`: `AbortSignal` ; `branch?`: `string` ; `commitDescription?`: `string` ; `commitTitle?`: `string` ; `fetch?`: (`input`: RequestInfo \| URL, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `Request` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `files`: (`URL` \| [`CommitEditFileParams`](interfaces/CommitEditFileParams) \| `File` \| \{ `content`: [`ContentSource`](modules#contentsource) ; `path`: `string`  })[] ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `maxFolderDepth?`: `number` ; `parentCommit?`: `string` ; `rangeEditCache?`: [`RangeEditCache`](modules#rangeeditcache) ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `useWebWorkers?`: `boolean` \| \{ `minSize?`: `number` ; `poolSize?`: `number`  } ; `useXet?`: `boolean`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[uploadfiles.returns]]

`Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Definido em[[uploadfiles.defined-in]]

[packages/hub/src/lib/upload-files.ts:6](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/upload-files.ts#L6)

___

### uploadFilesWithProgress

▸ **uploadFilesWithProgress**(`params`): `AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent), [`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

Uploads com progresso

É necessário que o XMLHttpRequest esteja disponível para eventos de progresso em uploads de modelos, conjuntos de dados e espaços. Defina useWebWorkers como true para ter eventos de progresso para o hashing de modelos, conjuntos de dados e espaços.

#### Parâmetros[[uploadfileswithprogress.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `params` | \{ `abortSignal?`: `AbortSignal` ; `branch?`: `string` ; `commitDescription?`: `string` ; `commitTitle?`: `string` ; `files`: (`URL` \| [`CommitEditFileParams`](interfaces/CommitEditFileParams) \| `File` \| \{ `content`: [`ContentSource`](modules#contentsource) ; `path`: `string`  })[] ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `maxFolderDepth?`: `number` ; `parentCommit?`: `string` ; `rangeEditCache?`: [`RangeEditCache`](modules#rangeeditcache) ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `useWebWorkers?`: `boolean` \| \{ `minSize?`: `number` ; `poolSize?`: `number`  } ; `useXet?`: `boolean`  } & `Partial`\<`CredentialsParams`\> |

#### Retorna[[uploadfileswithprogress.returns]]

`AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent), [`CommitOutput`](interfaces/CommitOutput) \| `undefined`\>

#### Definido em[[uploadfileswithprogress.defined-in]]

[packages/hub/src/lib/upload-files-with-progress.ts:21](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/upload-files-with-progress.ts#L21)

___

### validateTensorEntry

▸ **validateTensorEntry**(`path`, `tensorName`, `info`, `fileSizeBytes`): `void`

Valida uma entrada de tensor de um cabeçalho: as dimensões são inteiros finitos menores que `MAX_TENSOR_DIM`, `data_offsets` são válidos e — quando o tamanho do arquivo é conhecido — a extensão de bytes declarada cabe no arquivo. `data_offsets` é verificado em vez de `shape * dtype size` porque os dois podem divergir legítimamente (padding), portanto os offsets são a única fonte de verdade que o formato nos fornece.

#### Parâmetros[[validatetensorentry.parameters]]

| Nome | Tipo |
| :------ | :------ |
| `path` | `string` |
| `tensorName` | `string` |
| `info` | [`TensorInfo`](interfaces/TensorInfo) |
| `fileSizeBytes` | `undefined` \| `number` |

#### Retorna[[validatetensorentry.returns]]

`void`

#### Definido em[[validatetensorentry.defined-in]]

[packages/hub/src/lib/parse-safetensors-metadata.ts:246](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L246)

___

### whoAmI

▸ **whoAmI**(`params`): `Promise`\<[`WhoAmI`](modules#whoami) & \{ `auth`: [`AuthInfo`](interfaces/AuthInfo)  }\>

#### Parâmetros[[whoami.parameters]]

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

#### Retorna[[whoami.returns]]

`Promise`\<[`WhoAmI`](modules#whoami) & \{ `auth`: [`AuthInfo`](interfaces/AuthInfo)  }\>

#### Definido em[[whoami.defined-in]]

[packages/hub/src/lib/who-am-i.ts:63](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/who-am-i.ts#L63)