langchain_community.utilities.searx_search.SearxSearchWrapper

class langchain_community.utilities.searx_search.SearxSearchWrapper[source]

Bases: BaseModel

封装了Searx API。

要使用，需要通过传递命名参数“searx_host”或导出环境变量“SEARX_HOST”来提供searx主机。

在某些情况下，您可能希望禁用SSL验证，例如在本地运行searx时。您可以通过传递命名参数“unsecure”来实现此目的。您还可以将主机URL方案传递为“http”以禁用SSL。

示例：
from langchain_community.utilities import SearxSearchWrapper
searx = SearxSearchWrapper(searx_host="http://localhost:8888")
禁用SSL的示例：
from langchain_community.utilities import SearxSearchWrapper
# 请注意，如果将url方案传递为http，则不需要unsecure参数
searx = SearxSearchWrapper(searx_host="http://localhost:8888",
                                        unsecure=True)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param aiosession: Optional[Any] = None
param categories: Optional[List[str]] = []
param engines: Optional[List[str]] = []
param headers: Optional[dict] = None
param k: int = 10
param params: dict [Optional]
param query_suffix: Optional[str] = ''
param searx_host: str = ''
param unsecure: bool = False
async aresults(query: str, num_results: int, engines: Optional[List[str]] = None, query_suffix: Optional[str] = '', **kwargs: Any) → List[Dict][source]

使用JSON结果进行异步查询。

使用aiohttp。有关更多信息，请参阅`results`。

Parameters

  • query (str) –

  • num_results (int) –

  • engines (Optional[List[str]]) –

  • query_suffix (Optional[str]) –

  • kwargs (Any) –

Return type

List[Dict]

async arun(query: str, engines: Optional[List[str]] = None, query_suffix: Optional[str] = '', **kwargs: Any) → str[source]

`run`的异步版本。

Parameters

  • query (str) –

  • engines (Optional[List[str]]) –

  • query_suffix (Optional[str]) –

  • kwargs (Any) –

Return type

str

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

Parameters

  • _fields_set (Optional[SetStr]) –

  • values (Any) –

Return type

Model

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to include in new model

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to exclude from new model, as with values this takes precedence over include

  • update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

  • deep (bool) – set to True to make a deep copy of the model

  • self (Model) –

Returns

new model instance

Return type

Model

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • by_alias (bool) –

  • skip_defaults (Optional[bool]) –

  • exclude_unset (bool) –

  • exclude_defaults (bool) –

  • exclude_none (bool) –

Return type

DictStrAny

classmethod from_orm(obj: Any) → Model
Parameters

obj (Any) –

Return type

Model

json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • by_alias (bool) –

  • skip_defaults (Optional[bool]) –

  • exclude_unset (bool) –

  • exclude_defaults (bool) –

  • exclude_none (bool) –

  • encoder (Optional[Callable[[Any], Any]]) –

  • models_as_dict (bool) –

  • dumps_kwargs (Any) –

Return type

unicode

classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model
Parameters

  • path (Union[str, Path]) –

  • content_type (unicode) –

  • encoding (unicode) –

  • proto (Protocol) –

  • allow_pickle (bool) –

Return type

Model

classmethod parse_obj(obj: Any) → Model
Parameters

obj (Any) –

Return type

Model

classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model
Parameters

  • b (Union[str, bytes]) –

  • content_type (unicode) –

  • encoding (unicode) –

  • proto (Protocol) –

  • allow_pickle (bool) –

Return type

Model

results(query: str, num_results: int, engines: Optional[List[str]] = None, categories: Optional[List[str]] = None, query_suffix: Optional[str] = '', **kwargs: Any) → List[Dict][source]

通过Searx API运行查询并返回带有元数据的结果。

参数：

query: 要搜索的查询。 query_suffix: 附加到查询的额外后缀。 num_results: 限制要返回的结果数量。 engines: 用于查询的引擎列表。 categories: 用于查询的类别列表。 **kwargs: 传递给searx API的额外参数。

返回：

具有以下键的字典： {

snippet: 结果的描述。 title: 结果的标题。 link: 结果的链接。 engines: 用于结果的引擎。 category: 结果的Searx类别。

}

Parameters

  • query (str) –

  • num_results (int) –

  • engines (Optional[List[str]]) –

  • categories (Optional[List[str]]) –

  • query_suffix (Optional[str]) –

  • kwargs (Any) –

Return type

List[Dict]

run(query: str, engines: Optional[List[str]] = None, categories: Optional[List[str]] = None, query_suffix: Optional[str] = '', **kwargs: Any) → str[source]

通过Searx API运行查询并解析结果。

您可以将任何其他参数传递给searx查询API。

参数:

query: 要搜索的查询。 query_suffix: 附加到查询的额外后缀。 engines: 用于查询的引擎列表。 categories: 用于查询的类别列表。 **kwargs: 传递给searx API的额外参数。

返回:

str: 查询的结果。

引发:

ValueError: 如果查询出现错误。

示例:

这将向qwant引擎发出查询:

from langchain_community.utilities import SearxSearchWrapper
searx = SearxSearchWrapper(searx_host="http://my.searx.host")
searx.run("what is the weather in France ?", engine="qwant")

# 可以使用`query_suffix`使用searx的`!`语法选择引擎来实现相同的结果
searx.run("what is the weather in France ?", query_suffix="!qwant")
Parameters

  • query (str) –

  • engines (Optional[List[str]]) –

  • categories (Optional[List[str]]) –

  • query_suffix (Optional[str]) –

  • kwargs (Any) –

Return type

str

classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny
Parameters

  • by_alias (bool) –

  • ref_template (unicode) –

Return type

DictStrAny

classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode
Parameters

  • by_alias (bool) –

  • ref_template (unicode) –

  • dumps_kwargs (Any) –

Return type

unicode

classmethod update_forward_refs(**localns: Any) → None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Parameters

localns (Any) –

Return type

None

classmethod validate(value: Any) → Model
Parameters

value (Any) –

Return type

Model

Examples using SearxSearchWrapper