dhx?SrSSKrSSKJrJrJrJr SSKrSSKrSSK J r SSK J r J r JrJrJr S\4Sjr"SS \5r"S S \ 5rg) aaUtility for using SearxNG meta search API. SearxNG is a privacy-friendly free metasearch engine that aggregates results from `multiple search engines `_ and databases and supports the `OpenSearch `_ specification. More details on the installation instructions `here. <../../integrations/searx.html>`_ For the search API refer to https://docs.searxng.org/dev/search_api.html Quick Start ----------- In order to use this utility you need to provide the searx host. This can be done by passing the named parameter :attr:`searx_host ` or exporting the environment variable SEARX_HOST. Note: this is the only required parameter. Then create a searx search instance like this: .. code-block:: python from langchain_community.utilities import SearxSearchWrapper # when the host starts with `http` SSL is disabled and the connection # is assumed to be on a private network searx_host='http://self.hosted' search = SearxSearchWrapper(searx_host=searx_host) You can now use the ``search`` instance to query the searx API. Searching --------- Use the :meth:`run() ` and :meth:`results() ` methods to query the searx API. Other methods are available for convenience. :class:`SearxResults` is a convenience wrapper around the raw json result. Example usage of the ``run`` method to make a search: .. code-block:: python s.run(query="what is the best search engine?") Engine Parameters ----------------- You can pass any `accepted searx search API `_ parameters to the :py:class:`SearxSearchWrapper` instance. In the following example we are using the :attr:`engines ` and the ``language`` parameters: .. code-block:: python # assuming the searx host is set as above or exported as an env variable s = SearxSearchWrapper(engines=['google', 'bing'], language='es') Search Tips ----------- Searx offers a special `search syntax `_ that can also be used instead of passing engine parameters. For example the following query: .. code-block:: python s = SearxSearchWrapper("langchain library", engines=['github']) # can also be written as: s = SearxSearchWrapper("langchain library !github") # or even: s = SearxSearchWrapper("langchain library !gh") In some situations you might want to pass an extra string to the search query. For example when the `run()` method is called by an agent. The search suffix can also be used as a way to pass extra parameters to searx or the underlying search engines. .. code-block:: python # select the github engine and pass the search suffix s = SearchWrapper("langchain library", query_suffix="!gh") s = SearchWrapper("langchain library") # select github the conventional google search syntax s.run("large language models", query_suffix="site:github.com") *NOTE*: A search suffix can be defined on both the instance and the method level. The resulting query will be the concatenation of the two with the former taking precedence. See `SearxNG Configured Engines `_ and `SearxNG Search Syntax `_ for more details. Notes ----- This wrapper is based on the SearxNG fork https://github.com/searxng/searxng which is better maintained than the original Searx project and offers more features. Public searxNG instances often use a rate limiter for API usage, so you might want to 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 own network as described `here `_. For a list of public SearxNG instances see https://searx.space/ N)AnyDictListOptional)get_from_dict_or_env) BaseModel ConfigDictField PrivateAttrmodel_validatorreturnc SSS.$)Nenjson)languageformatrb/var/www/html/shao/venv/lib/python3.13/site-packages/langchain_community/utilities/searx_search.py_get_default_paramsrs  //rc^\rSrSr%SrSr\\S'S\4U4SjjrS\4Sjr \ S\ 4S j5r \ S\ 4S j5r S rU=r$) SearxResultsz,Dict like wrapper around search api results._datadatac\>[R"U5n[TU] U5 Xlg)zATake a raw result from Searx and make it into a dict like object.N)rloadssuper__init____dict__)selfr json_data __class__s rr SearxResults.__init__s#JJt$  # rr cUR$)z$Text representation of searx result.)rr"s r__str__SearxResults.__str__s zzrc$URS5$)z7Silence mypy for accessing this field. :meta private: resultsgetr's rr+SearxResults.resultss xx ""rc$URS5$)z#Helper accessor on the json result.answersr,r's rr0SearxResults.answerssxx ""r)r!)__name__ __module__ __qualname____firstlineno____doc__rstr__annotations__r r(propertyrr+r0__static_attributes__ __classcell__)r$s@rrrs]6E3OS ######rrcX\rSrSr%Sr\"5r\\S'Sr \ \S'Sr \ \S'\ "\S9r\\S 'S r\\\S '/r\\\ \S '/r\\\ \S 'Sr\\ \S'Sr\\S'S r\\\S'\"SS9\S\S\4Sj55r\"SS9r S \S\4Sjr!S \S\4Sjr"S#S\ S \\\ S \\\ S\\ S\S\ 4 Sjjr#S$S\ S \\\ S\\ S\S\ 4 Sjjr$S#S\ S\S \\\ S \\\ S\\ S\S\\4S jjr%S$S\ S\S \\\ S\\ S\S\\4 S!jjr&S"r'g )%SearxSearchWrapperaWrapper for Searx API. To use you need to provide the searx host by passing the named parameter ``searx_host`` or exporting the environment variable ``SEARX_HOST``. In some situations you might want to disable SSL verification, for example if you are running searx locally. You can do this by passing the named parameter ``unsecure``. You can also pass the host url scheme as ``http`` to disable SSL. Example: .. code-block:: python from langchain_community.utilities import SearxSearchWrapper searx = SearxSearchWrapper(searx_host="http://localhost:8888") Example with SSL disabled: .. code-block:: python from langchain_community.utilities import SearxSearchWrapper # note the unsecure parameter is not needed if you pass the url scheme as # http searx = SearxSearchWrapper(searx_host="http://localhost:8888", unsecure=True) _resultr searx_hostFunsecure)default_factoryparamsNheadersengines categories query_suffix k aiosessionbefore)modevaluesr cURS05n[5n0UEUEUS'URS5nU(aSRU5USS'URS5nU(aSRU5USS'[USS5nUR S5(d[ SUS 35 S U-nOUR S 5(aS US 'XaS'U$)z?Validate that custom searx params are merged with default ones.rCrE,rFr@ SEARX_HOSThttpzRWarning: missing the url scheme on host ! assuming secure https:// zhttps://zhttp://TrA)r-rjoinr startswithprint)clsrM user_paramsdefaultrErFr@s rvalidate_params"SearxSearchWrapper.validate_paramssjj2. %'5g55x**Y' *-((7*;F8 Y 'ZZ - -0XXj-AF8 \ *)&, M $$V,, ++5,a9 $j0J  " "9 - -!%F: )| rforbid)extrac[R"URURUUR(+S9nUR (d[ SUR5e[UR5nX0l U$)zActual request to searx API.rDrCverifySearx API returned an error: ) requestsr-r@rDrAok ValueErrortextrr?)r"rC raw_resultress r_searx_api_query#SearxSearchWrapper._searx_api_querys^\\ OOLL}}$  }}-B 3K3- -K gt $ $W)9 # 1F9  j$ ' 'C Oa,?#&88J#7F< ##F+ s{{ a KKNE   !KKs{{8TVV?T U?T!y"!5?T UVE 2E !Vs9F c # SU0n0UREUEUEnUR(a3[UR5S:aUS==SUR-- ss'[U[5(a[U5S:aUS==SU-- ss'[U[ 5(a#[U5S:aSR U5US'URU5IShvN n[UR5S:aURSnU$[UR5S:aISR URSURV s/sHoRSS 5PM sn 5nU$S nU$Ns sn f7f) z Asynchronously version of `run`.rurrRrOrENrvrwrrx) rCrGryrzr7r{rSrqr0r+rIr-) r"rsrErGrnr|rCrfr}r~s rarunSearxSearchWrapper.arunjsX  6DKK575f5   T%6%6!7!!; 3K3!2!22 2K lC ( (S->-B 3K3- -K gt $ $W)9 # 1F9 **622 s{{ a KKNE   !KKs{{8TVV?T U?T!y"!5?T UVE 2E 3!Vs%CE9E2A-E9 E4%E94E9 num_resultsc SU0n0UREUEUEnUR(a3[UR5S:aUS==SUR-- ss'[U[5(a[U5S:aUS==SU-- ss'[U[ 5(a#[U5S:aSR U5US'[U[ 5(a#[U5S:aSR U5US'URU5RSUn [U 5S:XaSS 0/$U V s/sH'n U RS S 5U S U S U SU SS.PM) sn $s sn f)aRun query through Searx API and returns the results with metadata. Args: query: The query to search for. query_suffix: Extra suffix appended to the query. num_results: Limit the number of results to return. engines: List of engines to use for the query. categories: List of categories to use for the query. **kwargs: extra parameters to pass to the searx API. Returns: 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. } rurrRrOrErFNResultNo good Search Result was foundrwrtitleurlcategorysnippetrlinkrEr) rCrGryrzr7r{rSrgr+r-) r"rsrrErFrGrnr|rCr+rps rr+SearxSearchWrapper.resultssq>  6DKK575f5   T%6%6!7!!; 3K3!2!22 2K lC ( (S->-B 3K3- -K gt $ $W)9 # 1F9  j$ ' 'C Oa,?#&88J#7F< ''/77 E w<1 @AB B"  " "::i4u !),":.  "   s5-E%c # SU0n0UREUEUEnUR(a3[UR5S:aUS==SUR-- ss'[U[5(a[U5S:aUS==SU-- ss'[U[ 5(a#[U5S:aSR U5US'URU5IShvN RSUn[U5S:XaSS0/$UV s/sH'n U RS S 5U S U S U SU S S.PM) sn $NYs sn f7f)zTAsynchronously query with json results. Uses aiohttp. See `results` for more info. rurrRrOrENrrrwrrrrr) rCrGryrzr7r{rSrqr+r-) r"rsrrErGrnr|rCr+rps raresultsSearxSearchWrapper.aresultssQ  6DKK575f5   T%6%6!7!!; 3K3!2!22 2K lC ( (S->-B 3K3- -K gt $ $W)9 # 1F9 //77@@+N w<1 @AB B"  " "::i4u !),":.  "  8  s$CD>D7)D>-D94D>9D>)r?)NNr)Nr)(r2r3r4r5r6r r?rr8r@r7rAboolr rrCdictrDrrErrFrGrIintrJrr classmethodrrYr model_configrgrqrrr+rr:rrrr=r=ss6(MG\)JHd)<=FD="GXd^"#%GXd3i %&(Jc#("$L(3-$ AsK $J $(#Tc$6L t  d|>(,*.&( CC$s)$CT#Y' C sm C  C CP(,&( !!$s)$!sm !  ! !N(,*.&( 7 7 7 $s)$ 7 T#Y' 7 sm 7 7  d7 z(,&( $ $ $ $s)$ $ sm $  $  d$ $ rr=)r6rtypingrrrrrkralangchain_core.utilsrpydanticrr r r r rrrr=rrrrsPB ,,50T0#4#:x x r