langchain_community.utilities.you.YouSearchAPIWrapper

class langchain_community.utilities.you.YouSearchAPIWrapper

Bases: BaseModel

包装器，用于you.com搜索API。

要连接到You.com API，需要一个API密钥，您可以在https://api.you.com获取。 您可以在https://documentation.you.com查看文档。

您需要设置环境变量`YDC_API_KEY`以使检索器运行。

ydc_api_key: str, optional

you.com API密钥，如果环境中未设置YDC_API_KEY

num_web_results: int, optional

要返回的Web结果的最大数量，必须小于20

safesearch: str, optional

安全搜索设置，可选值为off、moderate、strict，默认为moderate

country: str, optional

国家代码，例如：’US’代表美国，请参阅API文档以获取列表

k: int, optional

使用`results()`返回的文档的最大数量

n_hits: int, optional, deprecated

num_web_results的别名

n_snippets_per_hit: int, optional

限制每个命中返回的摘要数量

endpoint_type: str, optional

you.com端点：search、news、rag； web`和`snippet`别名`search rag`返回`{‘message’: ‘Forbidden’} @todo `news`端点

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 country: Optional[str] = None

param endpoint_type: Literal['search', 'news', 'rag', 'snippet'] = 'search'

param k: Optional[int] = None

param n_hits: Optional[int] = None

param n_snippets_per_hit: Optional[int] = None

param num_web_results: Optional[int] = None

param safesearch: Optional[str] = None

param ydc_api_key: Optional[str] = None

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

raw_results(query: str, **kwargs: Any) → Dict

运行查询通过you.com搜索并返回命中结果。

参数：

query: 要搜索的查询。 num_web_results: 要返回的最大结果数。 safesearch: 安全搜索设置，

可选值为off、moderate、strict，默认为moderate。

country: 国家代码

返回：YouAPIOutput

Parameters

• query (str) –

• kwargs (Any) –

Return type

Dict

async raw_results_async(query: str, **kwargs: Any) → Dict

从you.com搜索API异步获取结果。

Parameters

• query (str) –

• kwargs (Any) –

Return type

Dict

results(query: str, **kwargs: Any) → List[Document]

通过you.com搜索运行查询并将结果解析为文档。

Parameters

• query (str) –

• kwargs (Any) –

Return type

List[Document]

async results_async(query: str, **kwargs: Any) → List[Document]

Parameters

• query (str) –

• kwargs (Any) –

Return type

List[Document]

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 YouSearchAPIWrapper

• For use in Chaining section