- Converted CivitaiAPI to HuggingFaceAPI - Updated all references from civitai to huggingface - Renamed web files (CSS/JS) - Implemented core HF API methods: * search_models() * get_model_info() * get_model_files() * download_file() - Clean API structure for HuggingFace integration Next: Update server routes and helpers for HF endpoints
114 lines
5.1 KiB
Python
114 lines
5.1 KiB
Python
# ================================================
|
|
# File: api/huggingface.py
|
|
# ================================================
|
|
import requests
|
|
import json
|
|
from typing import List, Optional, Dict, Any, Union
|
|
|
|
class HuggingFaceAPI:
|
|
"""Simple wrapper for interacting with the HuggingFace API."""
|
|
BASE_URL = "https://huggingface.co/api"
|
|
|
|
def __init__(self, api_key: Optional[str] = None):
|
|
self.api_key = api_key
|
|
self.base_headers = {'Content-Type': 'application/json'}
|
|
if api_key:
|
|
self.base_headers["Authorization"] = f"Bearer {api_key}"
|
|
print("[HuggingFace API] Using API Key.")
|
|
else:
|
|
print("[HuggingFace API] No API Key provided.")
|
|
|
|
def _get_request_headers(self, method: str, has_json_data: bool) -> Dict[str, str]:
|
|
"""Returns headers for a specific request."""
|
|
headers = self.base_headers.copy()
|
|
# Don't send content-type for GET/HEAD if no json_data
|
|
if method.upper() in ["GET", "HEAD"] and not has_json_data:
|
|
headers.pop('Content-Type', None)
|
|
return headers
|
|
|
|
def _request(self, method: str, endpoint: str, params: Optional[Dict] = None,
|
|
json_data: Optional[Dict] = None, stream: bool = False,
|
|
allow_redirects: bool = True, timeout: int = 30) -> Union[Dict[str, Any], requests.Response, None]:
|
|
"""Makes a request to the HuggingFace API and handles basic errors."""
|
|
url = f"{self.BASE_URL}/{endpoint.lstrip('/')}"
|
|
request_headers = self._get_request_headers(method, json_data is not None)
|
|
|
|
try:
|
|
response = requests.request(
|
|
method,
|
|
url,
|
|
headers=request_headers,
|
|
params=params,
|
|
json=json_data,
|
|
stream=stream,
|
|
allow_redirects=allow_redirects,
|
|
timeout=timeout
|
|
)
|
|
response.raise_for_status() # Raise HTTPError for bad responses (4xx or 5xx)
|
|
|
|
if stream:
|
|
return response # Return the response object for streaming
|
|
|
|
# Handle No Content response (e.g., 204)
|
|
if response.status_code == 204 or not response.content:
|
|
return None
|
|
|
|
return response.json()
|
|
|
|
except requests.exceptions.HTTPError as http_err:
|
|
error_detail = None
|
|
status_code = http_err.response.status_code
|
|
try:
|
|
error_detail = http_err.response.json()
|
|
except json.JSONDecodeError:
|
|
error_detail = http_err.response.text[:200] # First 200 chars
|
|
print(f"HuggingFace API HTTP Error ({method} {url}): Status {status_code}, Response: {error_detail}")
|
|
# Return a structured error dictionary
|
|
return {"error": f"HTTP Error: {status_code}", "details": error_detail, "status_code": status_code}
|
|
|
|
except requests.exceptions.RequestException as req_err:
|
|
print(f"HuggingFace API Request Error ({method} {url}): {req_err}")
|
|
return {"error": str(req_err), "details": None, "status_code": None}
|
|
|
|
except json.JSONDecodeError as json_err:
|
|
print(f"HuggingFace API Error: Failed to decode JSON response from {url}: {json_err}")
|
|
# Include response text if possible and not streaming
|
|
response_text = response.text[:200] if not stream and hasattr(response, 'text') else "N/A"
|
|
return {"error": "Invalid JSON response", "details": response_text, "status_code": response.status_code if hasattr(response, 'status_code') else None}
|
|
|
|
def search_models(self, query: str, limit: int = 20) -> Optional[Dict[str, Any]]:
|
|
"""Searches for models on HuggingFace. (GET /models)"""
|
|
endpoint = "/models"
|
|
params = {
|
|
"search": query,
|
|
"limit": limit
|
|
}
|
|
result = self._request("GET", endpoint, params=params)
|
|
if isinstance(result, dict) and "error" in result:
|
|
return result
|
|
return result
|
|
|
|
def get_model_files(self, model_id: str) -> Optional[Dict[str, Any]]:
|
|
"""Gets files for a specific HuggingFace model. (GET /models/{id}/tree)"""
|
|
endpoint = f"/models/{model_id}/tree"
|
|
result = self._request("GET", endpoint)
|
|
if isinstance(result, dict) and "error" in result:
|
|
return result
|
|
return result
|
|
|
|
def get_model_info(self, model_id: str) -> Optional[Dict[str, Any]]:
|
|
"""Gets information about a model by its ID. (GET /models/{id})"""
|
|
endpoint = f"/models/{model_id}"
|
|
result = self._request("GET", endpoint)
|
|
if isinstance(result, dict) and "error" in result:
|
|
return result
|
|
return result
|
|
|
|
def download_file(self, model_id: str, filename: str) -> Optional[requests.Response]:
|
|
"""Downloads a specific file from HuggingFace. (GET /models/{id}/resolve/main/{filename})"""
|
|
endpoint = f"/models/{model_id}/resolve/main/{filename}"
|
|
result = self._request("GET", endpoint, stream=True)
|
|
if isinstance(result, dict) and "error" in result:
|
|
return result
|
|
return result
|