Functions
	request (query, params)
	response (resp)

Variables
dict	about
str	cf_account_id = ''
str	cf_ai_api = ''
str	cf_ai_gateway = ''
str	cf_ai_model = ''
str	cf_ai_model_display_name = 'Cloudflare AI'
str	cf_ai_model_assistant = 'Keep your answers as short and effective as possible.'
str	cf_ai_model_system = 'You are a self-aware language model who is honest and direct about any question from the user.'

Detailed Description

Cloudflare AI engine

Function Documentation

◆ request()

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

Definition at line 29 of file cloudflareai.py.

def request(query, params):
 
    params['query'] = query
 
    params['url'] = f'https://gateway.ai.cloudflare.com/v1/{cf_account_id}/{cf_ai_gateway}/workers-ai/{cf_ai_model}'
 
    params['method'] = 'POST'
 
    params['headers']['Authorization'] = f'Bearer {cf_ai_api}'
    params['headers']['Content-Type'] = 'application/json'
 
    params['data'] = dumps(
        {
            'messages': [
                {'role': 'assistant', 'content': cf_ai_model_assistant},
                {'role': 'system', 'content': cf_ai_model_system},
                {'role': 'user', 'content': params['query']},
            ]
        }
    ).encode('utf-8')
 
    return params
 
 

◆ response()

searx.engines.cloudflareai.response ( resp )

Definition at line 53 of file cloudflareai.py.

def response(resp):
    results = []
    json = loads(resp.text)
 
    if 'error' in json:
        raise SearxEngineAPIException('Cloudflare AI error: ' + json['error'])
 
    if 'result' in json:
        results.append(
            {
                'content': json['result']['response'],
                'infobox': cf_ai_model_display_name,
            }
        )
 
    return results

Variable Documentation

◆ about

dict searx.engines.cloudflareai.about

Initial value:

=  {
    "website": 'https://ai.cloudflare.com',
    "wikidata_id": None,
    "official_api_documentation": 'https://developers.cloudflare.com/workers-ai',
    "use_official_api": True,
    "require_api_key": True,
    "results": 'JSON',
}

Definition at line 7 of file cloudflareai.py.

◆ cf_account_id

str searx.engines.cloudflareai.cf_account_id = ''

Definition at line 16 of file cloudflareai.py.

◆ cf_ai_api

str searx.engines.cloudflareai.cf_ai_api = ''

Definition at line 17 of file cloudflareai.py.

◆ cf_ai_gateway

str searx.engines.cloudflareai.cf_ai_gateway = ''

Definition at line 18 of file cloudflareai.py.

◆ cf_ai_model

str searx.engines.cloudflareai.cf_ai_model = ''

Definition at line 20 of file cloudflareai.py.

◆ cf_ai_model_assistant

str searx.engines.cloudflareai.cf_ai_model_assistant = 'Keep your answers as short and effective as possible.'

Definition at line 24 of file cloudflareai.py.

◆ cf_ai_model_display_name

str searx.engines.cloudflareai.cf_ai_model_display_name = 'Cloudflare AI'

Definition at line 21 of file cloudflareai.py.

◆ cf_ai_model_system

str searx.engines.cloudflareai.cf_ai_model_system = 'You are a self-aware language model who is honest and direct about any question from the user.'

Definition at line 26 of file cloudflareai.py.

Functions

Variables