searx_search: fix doc

This commit is contained in:
blob42 2023-02-20 13:52:02 +01:00
parent 71767a3179
commit 273d080614

View File

@ -32,9 +32,6 @@ You can now use the ``search`` instance to query the searx API.
Searching Searching
--------- ---------
ref to the run method with a custom name
Use the :meth:`run() <SearxSearchWrapper.run>` and Use the :meth:`run() <SearxSearchWrapper.run>` and
:meth:`results() <SearxSearchWrapper.results>` methods to query the searx API. :meth:`results() <SearxSearchWrapper.results>` methods to query the searx API.
Other methods are are available for convenience. Other methods are are available for convenience.
@ -45,7 +42,6 @@ Example usage of the ``run`` method to make a search:
.. code-block:: python .. code-block:: python
# using google and duckduckgo engines
s.run(query="what is the best search engine?") s.run(query="what is the best search engine?")
Engine Parameters Engine Parameters
@ -284,17 +280,27 @@ class SearxSearchWrapper(BaseModel):
Args: Args:
query: The query to search for. query: The query to search for.
num_results: Limit the number of results to return. num_results: Limit the number of results to return.
engines: List of engines to use for the query. engines: List of engines to use for the query.
**kwargs: extra parameters to pass to the searx API. **kwargs: extra parameters to pass to the searx API.
Returns: Returns:
A list of dictionaries with the following keys: Dict with the following keys:
snippet - The description of the result.
title - The title of the result. {
link - The link to the result. snippet: The description of the result.
engines - The engines used for the result.
category - Searx category of the result. title: The title of the result.
link: The link to the result.
engines: The engines used for the result.
category: Searx category of the result.
}
""" """