From 273d080614afda65e87025485453c56f38dd5575 Mon Sep 17 00:00:00 2001 From: blob42 Date: Mon, 20 Feb 2023 13:52:02 +0100 Subject: [PATCH] searx_search: fix doc --- langchain/utilities/searx_search.py | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/langchain/utilities/searx_search.py b/langchain/utilities/searx_search.py index 478d2e3b..d012b384 100644 --- a/langchain/utilities/searx_search.py +++ b/langchain/utilities/searx_search.py @@ -32,9 +32,6 @@ You can now use the ``search`` instance to query the searx API. Searching --------- -ref to the run method with a custom name - - Use the :meth:`run() ` and :meth:`results() ` methods to query the searx API. Other methods are are available for convenience. @@ -45,7 +42,6 @@ Example usage of the ``run`` method to make a search: .. code-block:: python - # using google and duckduckgo engines s.run(query="what is the best search engine?") Engine Parameters @@ -284,17 +280,27 @@ class SearxSearchWrapper(BaseModel): Args: query: The query to search for. + num_results: Limit the number of results to return. + engines: List of engines to use for the query. + **kwargs: extra parameters to pass to the searx API. Returns: - A list of dictionaries with the following keys: - snippet - The description 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. + Dict with the following keys: + + { + snippet: The description 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. + } """