searx: update doc, rate limiter whitelist feature on searx merged

This commit is contained in:
blob42 2023-06-16 12:04:56 +02:00
parent 5b515b8bee
commit 48e642c353
3 changed files with 29 additions and 6 deletions

View File

@ -67,4 +67,24 @@ tools = load_tools(["searx-search-results-json"],
num_results=5) num_results=5)
``` ```
For more information on tools, see [this page](/docs/modules/agents/tools/getting_started.md) #### Quickly creating tools
This examples showcases a quick way to create multiple tools from the same
wrapper.
```python
from langchain.tools.searx_search.tool import SearxSearchResults
wrapper = SearxSearchWrapper(searx_host="**")
github_tool = SearxSearchResults(name="Github", wrapper=wrapper,
kwargs = {
"engines": ["github"],
})
arxiv_tool = SearxSearchResults(name="Arxiv", wrapper=wrapper,
kwargs = {
"engines": ["arxiv"]
})
```
For more information on tools, see [this page](../modules/agents/tools/getting_started.md)

View File

@ -1,5 +1,5 @@
"""Tool for the SearxNG search API.""" """Tool for the SearxNG search API."""
from typing import Optional, Any from typing import Optional
from pydantic import Extra from pydantic import Extra
@ -21,7 +21,7 @@ class SearxSearchRun(BaseTool):
"Input should be a search query." "Input should be a search query."
) )
wrapper: SearxSearchWrapper wrapper: SearxSearchWrapper
kwargs: dict[Any, Any] = Field(default_factory=dict) kwargs: dict = Field(default_factory=dict)
def _run( def _run(
self, self,
@ -51,7 +51,7 @@ class SearxSearchResults(BaseTool):
) )
wrapper: SearxSearchWrapper wrapper: SearxSearchWrapper
num_results: int = 4 num_results: int = 4
kwargs: dict[Any, Any] = Field(default_factory=dict) kwargs: dict = Field(default_factory=dict)
class Config: class Config:
"""Pydantic config.""" """Pydantic config."""
@ -72,4 +72,6 @@ class SearxSearchResults(BaseTool):
run_manager: Optional[AsyncCallbackManagerForToolRun] = None, run_manager: Optional[AsyncCallbackManagerForToolRun] = None,
) -> str: ) -> str:
"""Use the tool asynchronously.""" """Use the tool asynchronously."""
return (await self.wrapper.aresults(query, self.num_results, **self.kwargs)).__str__() return (
await self.wrapper.aresults(query, self.num_results, **self.kwargs)
).__str__()

View File

@ -120,7 +120,8 @@ Public searxNG instances often use a rate limiter for API usage, so you might wa
use a self hosted instance and disable the rate limiter. use a self hosted instance and disable the rate limiter.
If you are self-hosting an instance you can customize the rate limiter for your If you are self-hosting an instance you can customize the rate limiter for your
own network as described `here <https://github.com/searxng/searxng/pull/2129>`_. own network as described
`here <https://docs.searxng.org/src/searx.botdetection.html#limiter-src>`_.
For a list of public SearxNG instances see https://searx.space/ For a list of public SearxNG instances see https://searx.space/