Functions
	request (_query, params)

EngineResults	response (resp)

Variables
dict	about

str	engine_type = 'online_dictionary'

list	categories = ['general', 'translate']

str	base_url = "https://libretranslate.com/translate"

str	api_key = ""

Detailed Description

LibreTranslate (Free and Open Source Machine Translation API)

Function Documentation

◆ request()

searx.engines.libretranslate.request	(		_query,
			params )

Definition at line 24 of file libretranslate.py.

def request(_query, params):
    request_url = random.choice(base_url) if isinstance(base_url, list) else base_url
 
    if request_url.startswith("https://libretranslate.com") and not api_key:
        return None
    params['url'] = f"{request_url}/translate"
 
    args = {
        'q': params['query'],
        'source': params['from_lang'][1],
        'target': params['to_lang'][1],
        'alternatives': 3,
    }
    if api_key:
        args['api_key'] = api_key
 
    params['data'] = json.dumps(args)
    params['method'] = 'POST'
    params['headers'] = {'Content-Type': 'application/json'}
    params['req_url'] = request_url
 
    return params
 
 

◆ response()

EngineResults searx.engines.libretranslate.response ( resp )

Definition at line 48 of file libretranslate.py.

def response(resp) -> EngineResults:
    results = EngineResults()
 
    json_resp = resp.json()
    text = json_resp.get('translatedText')
    if not text:
        return results
 
    item = results.types.Translations.Item(text=text, examples=json_resp.get('alternatives', []))
    results.add(results.types.Translations(translations=[item]))
 
    return results

Variable Documentation

◆ about

dict searx.engines.libretranslate.about

Initial value:

=  {
    "website": 'https://libretranslate.com',
    "wikidata_id": None,
    "official_api_documentation": 'https://libretranslate.com/docs/',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 8 of file libretranslate.py.

◆ api_key

str searx.engines.libretranslate.api_key = ""

Definition at line 21 of file libretranslate.py.

◆ base_url

str searx.engines.libretranslate.base_url = "https://libretranslate.com/translate"

Definition at line 20 of file libretranslate.py.

◆ categories

list searx.engines.libretranslate.categories = ['general', 'translate']

Definition at line 18 of file libretranslate.py.

◆ engine_type

str searx.engines.libretranslate.engine_type = 'online_dictionary'

Definition at line 17 of file libretranslate.py.

Functions

Variables