@huggingface/hub/src/types/api/api-index-tree.ts

Utilities to interact with the Hugging Face hub

export interface ApiIndexTreeEntry {
	type: "file" | "directory" | "unknown";
	size: number;
	path: string;
	oid: string;
	lfs?: {
		oid: string;
		size: number;
		/** Size of the raw pointer file, 100~200 bytes */
		pointerSize: number;
	};
	/**
	 * Xet content hash. Set for bucket file entries (always) and for repo LFS entries
	 * that have been migrated to xet.
	 */
	xetHash?: string;
	lastCommit?: {
		date: string;
		id: string;
		title: string;
	};
	security?: ApiFileScanResult;
}

export interface ApiFileScanResult {
	/** namespaced by repo type (models/, datasets/, spaces/) */
	repositoryId: string;
	blobId: string;
	name: string;
	safe: boolean;
	avScan?: ApiAVScan;
	pickleImportScan?: ApiPickleImportScan;
}

interface ApiAVScan {
	virusFound: boolean;
	virusNames?: string[];
}

type ApiSafetyLevel = "innocuous" | "suspicious" | "dangerous";

interface ApiPickleImport {
	module: string;
	name: string;
	safety: ApiSafetyLevel;
}

interface ApiPickleImportScan {
	highestSafetyLevel: ApiSafetyLevel;
	imports: ApiPickleImport[];
}