Functions
	init (_)

	request (query, params)

EngineResults	response (resp)

Variables
dict	about

list	categories = ['it', 'repos']

str	base_url = "https://huggingface.co"

str	huggingface_endpoint = 'models'

Detailed Description

`Hugging Face`_ search engine for SearXNG.

.. _Hugging Face: https://huggingface.co

Configuration
=============

The engine has the following additional settings:

- :py:obj:`huggingface_endpoint`

Configurations for endpoints:

.. code:: yaml

  - name: huggingface
    engine: huggingface
    shortcut: hf

  - name: huggingface datasets
    huggingface_endpoint: datasets
    engine: huggingface
    shortcut: hfd

  - name: huggingface spaces
    huggingface_endpoint: spaces
    engine: huggingface
    shortcut: hfs

Implementations
===============

Function Documentation

◆ init()

searx.engines.huggingface.init ( _ )

Definition at line 65 of file huggingface.py.

def init(_):
    if huggingface_endpoint not in ('datasets', 'models', 'spaces'):
        raise SearxEngineAPIException(f"Unsupported Hugging Face endpoint: {huggingface_endpoint}")
 
 

◆ request()

searx.engines.huggingface.request	(		query,
			params )

Definition at line 70 of file huggingface.py.

def request(query, params):
    query_params = {
        "direction": -1,
        "search": query,
    }
 
    params["url"] = f"{base_url}/api/{huggingface_endpoint}?{urlencode(query_params)}"
 
    return params
 
 

◆ response()

EngineResults searx.engines.huggingface.response ( resp )

Definition at line 81 of file huggingface.py.

def response(resp) -> EngineResults:
    results = EngineResults()
 
    data = resp.json()
 
    for entry in data:
        if huggingface_endpoint != 'models':
            url = f"{base_url}/{huggingface_endpoint}/{entry['id']}"
        else:
            url = f"{base_url}/{entry['id']}"
 
        published_date = None
        try:
            published_date = datetime.strptime(entry["createdAt"], "%Y-%m-%dT%H:%M:%S.%fZ")
        except (ValueError, TypeError):
            pass
 
        contents = []
        if entry.get("likes"):
            contents.append(f"Likes: {entry['likes']}")
        if entry.get("downloads"):
            contents.append(f"Downloads: {entry['downloads']:,}")
        if entry.get("tags"):
            contents.append(f"Tags: {', '.join(entry['tags'])}")
        if entry.get("description"):
            contents.append(f"Description: {entry['description']}")
 
        item = MainResult(
            title=entry["id"],
            content=html_to_text(" | ".join(contents)),
            url=url,
            publishedDate=published_date,
        )
        results.add(item)
 
    return results

Variable Documentation

◆ about

dict searx.engines.huggingface.about

Initial value:

=  {
    "website": "https://huggingface.co/",
    "wikidata_id": "Q108943604",
    "official_api_documentation": "https://huggingface.co/docs/hub/en/api",
    "use_official_api": True,
    "require_api_key": False,
    "results": "JSON",
}

Definition at line 43 of file huggingface.py.

◆ base_url

str searx.engines.huggingface.base_url = "https://huggingface.co"

Definition at line 54 of file huggingface.py.

◆ categories

list searx.engines.huggingface.categories = ['it', 'repos']

Definition at line 52 of file huggingface.py.

◆ huggingface_endpoint

str searx.engines.huggingface.huggingface_endpoint = 'models'

Definition at line 56 of file huggingface.py.

Functions

Variables