Functions
	request (_query, params)
EngineResults	response (resp)

Variables
dict	about
str	engine_type = 'online_dictionary'
list	categories = ['general', 'translate']
str	url = 'https://api-free.deepl.com/v2/translate'
	api_key = None

Detailed Description

Deepl translation engine

Function Documentation

◆ request()

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

pre-request callback

params<dict>:

- ``method`` : POST/GET
- ``headers``: {}
- ``data``: {}  # if method == POST
- ``url``: ''
- ``category``: 'search category'
- ``pageno``: 1  # number of the requested page

Definition at line 22 of file deepl.py.

def request(_query, params):
    '''pre-request callback
 
    params<dict>:
 
    - ``method`` : POST/GET
    - ``headers``: {}
    - ``data``: {}  # if method == POST
    - ``url``: ''
    - ``category``: 'search category'
    - ``pageno``: 1  # number of the requested page
    '''
 
    params['url'] = url
    params['method'] = 'POST'
    params['data'] = {'auth_key': api_key, 'text': params['query'], 'target_lang': params['to_lang'][1]}
 
    return params
 
 

◆ response()

EngineResults searx.engines.deepl.response ( resp )

Definition at line 42 of file deepl.py.

def response(resp) -> EngineResults:
 
    res = EngineResults()
    data = resp.json()
    if not data.get('translations'):
        return res
 
    translations = [res.types.Translations.Item(text=t['text']) for t in data['translations']]
    res.add(res.types.Translations(translations=translations))
 
    return res

Variable Documentation

◆ about

dict searx.engines.deepl.about

Initial value:

=  {
    "website": 'https://deepl.com',
    "wikidata_id": 'Q43968444',
    "official_api_documentation": 'https://www.deepl.com/docs-api',
    "use_official_api": True,
    "require_api_key": True,
    "results": 'JSON',
}

Definition at line 6 of file deepl.py.

◆ api_key

searx.engines.deepl.api_key = None

Definition at line 19 of file deepl.py.

◆ categories

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

Definition at line 16 of file deepl.py.

◆ engine_type

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

Definition at line 15 of file deepl.py.

◆ url

str searx.engines.deepl.url = 'https://api-free.deepl.com/v2/translate'

Definition at line 18 of file deepl.py.

Functions

Variables