YouSearchAPIWrapper#
- class langchain_community.utilities.you.YouSearchAPIWrapper[来源]#
基础类：
BaseModelyou.com 搜索和新闻 API 的封装器。
连接到You.com API需要一个API密钥，您可以在https://api.you.com获取。您可以在https://documentation.you.com/api-reference/查看文档。
您需要设置环境变量 YDC_API_KEY 以便检索器操作。
- ydc_api_key#
you.com API密钥，如果环境变量中未设置YDC_API_KEY
- Type:
字符串，可选
- endpoint_type#
you.com 端点：搜索、新闻、rag； web 和 snippet 别名 search rag 返回 {‘message’: ‘Forbidden’} @todo news 端点
- Type:
字符串，可选
- num_web_results#
返回的网页结果的最大数量，必须小于20。 这映射到News API的count查询参数。
- Type:
整数，可选
- safesearch#
安全搜索设置，可选值为 off、moderate、strict，默认为 moderate
- Type:
字符串，可选
- country#
国家代码，例如：'US' 代表美国，查看API文档以获取列表
- Type:
字符串，可选
- search_lang#
(News API) 语言代码，例如：'en' 表示英语，请参阅API文档以获取列表
- Type:
字符串，可选
- ui_lang#
- (News API) User interface language for the response, ex: ‘en’ for English,
查看API文档以获取列表
- Type:
字符串，可选
- spellcheck#
(News API) 是否对查询进行拼写检查，默认为 True
- Type:
布尔值，可选
- k#
使用results()返回的最大文档数量
- Type:
整数，可选
- n_hits#
num_web_results 的别名
- Type:
整数，可选，已弃用
- n_snippets_per_hit#
限制每次命中的片段返回数量
- Type:
整数，可选
通过解析和验证来自关键字参数的输入数据来创建一个新模型。
如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。
self 被显式地设为仅位置参数，以允许 self 作为字段名称。
- param country: str | None = None#
- param endpoint_type: Literal['search', 'news', 'rag', 'snippet'] = 'search'#
- param k: int | None = None#
- param n_hits: int | None = None#
- param n_snippets_per_hit: int | None = None#
- param num_web_results: int | None = None#
- param safesearch: Literal['off', 'moderate', 'strict'] | None = None#
- param search_lang: str | None = None#
- param spellcheck: bool | None = None#
- param ui_lang: str | None = None#
- param ydc_api_key: str | None = None#
- raw_results(query: str, **kwargs: Any) Dict[source]#
通过you.com搜索运行查询并返回结果。
- Parameters:
query (str) – 要搜索的查询。
kwargs (Any)
- Return type:
字典
返回: YouAPIOutput
- async raw_results_async(query: str, **kwargs: Any) Dict[source]#
从you.com搜索API异步获取结果。
- Parameters:
query (str)
kwargs (Any)
- Return type:
字典
使用 YouSearchAPIWrapper 的示例