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

Variables
str	engine_type = "online"
bool	language_support = True
list	categories = ["it"]
bool	paging = True
int	page_size = 10
bool	time_range_support = False
str	search_api = "https://learn.microsoft.com/api/search?"
dict	about

Detailed Description

Engine for Microsoft Learn, Microsoft's technical knowledge base.

To use this engine add the following entry to your engines list
in ``settings.yml``:

.. code:: yaml

  - name: microsoft learn
    engine: microsoft_learn
    shortcut: msl
    disabled: false

Function Documentation

◆ request()

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

Definition at line 37 of file microsoft_learn.py.

def request(query, params):
 
    if params['language'] == 'all':
        params['language'] = 'en-us'
 
    query_params = [
        ("search", query),
        ("locale", params["language"]),
        ("scoringprofile", "semantic-answers"),
        ("facet", "category"),
        ("facet", "products"),
        ("facet", "tags"),
        ("$top", "10"),
        ("$skip", (params["pageno"] - 1) * page_size),
        ("expandScope", "true"),
        ("includeQuestion", "false"),
        ("applyOperator", "false"),
        ("partnerId", "LearnSite"),
    ]
 
    params["url"] = search_api + urlencode(query_params)
    return params
 
 

◆ response()

EngineResults searx.engines.microsoft_learn.response ( resp )

Definition at line 61 of file microsoft_learn.py.

def response(resp) -> EngineResults:
    res = EngineResults()
    json_data = resp.json()
 
    for result in json_data["results"]:
        res.add(res.types.MainResult(url=result["url"], title=result["title"], content=result.get("description", "")))
 
    return res

Variable Documentation

◆ about

dict searx.engines.microsoft_learn.about

Initial value:

=  {
    "website": "https://learn.microsoft.com",
    "wikidata_id": "Q123663245",
    "official_api_documentation": None,
    "use_official_api": False,
    "require_api_key": False,
    "results": "JSON",
}

Definition at line 27 of file microsoft_learn.py.

◆ categories

list searx.engines.microsoft_learn.categories = ["it"]

Definition at line 20 of file microsoft_learn.py.

◆ engine_type

str searx.engines.microsoft_learn.engine_type = "online"

Definition at line 18 of file microsoft_learn.py.

◆ language_support

bool searx.engines.microsoft_learn.language_support = True

Definition at line 19 of file microsoft_learn.py.

◆ page_size

int searx.engines.microsoft_learn.page_size = 10

Definition at line 22 of file microsoft_learn.py.

◆ paging

bool searx.engines.microsoft_learn.paging = True

Definition at line 21 of file microsoft_learn.py.

◆ search_api

str searx.engines.microsoft_learn.search_api = "https://learn.microsoft.com/api/search?"

Definition at line 25 of file microsoft_learn.py.

◆ time_range_support

bool searx.engines.microsoft_learn.time_range_support = False

Definition at line 23 of file microsoft_learn.py.

Functions

Variables