langchain_community.utilities.you.YouSearchAPIWrapper¶
- class langchain_community.utilities.you.YouSearchAPIWrapper[源代码]¶
基类:
BaseModel用于封装you.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
- 类型
str, 可选
- endpoint_type¶
you.com端点：search, news, rag；web和snippet是search的别名；当rag返回时，将输出{‘message’: ‘Forbidden’} @todo news端点
- 类型
str, 可选
- num_web_results¶
返回的web结果的最大数量，必须小于20。此参数映射到新闻API的count查询参数。
- 类型
int, 可选
- safesearch¶
安全搜索设置，可以是off, moderate, strict，默认为moderate。
- 类型
str, 可选
- country¶
国家代码，例如：'US'代表美国，详见API文档以获取列表。
- 类型
str, 可选
- search_lang¶
（新闻API）语言代码，例如：'en'代表英语，详见API文档以获取列表。
- 类型
str, 可选
- ui_lang¶
- （新闻API）响应的用户界面语言，例如：'en'代表英语，详见API文档以获取列表。
bool, 可选
- 类型
str, 可选
- spellcheck¶
（新闻API）是否对查询进行拼写检查，默认为True。
- 类型
bool, 可选
- k¶
使用results返回的文档的最大数量。
- 类型
int, 可选
- n_hits¶
num_web_results的别名
- 类型
int, 可选，已弃用
- n_snippets_per_hit¶
限制每次搜索返回的片段数量。
- 类型
int, 可选
通过解析和验证关键字参数输入数据来创建新模型。
如果输入数据无法解析为有效模型，将引发ValidationError。
- 参数 ： country : Optional[str] = None¶
- 参数 ：endpoint_type : Literal['search', 'news', 'rag', 'snippet'] = 'search'¶
- 参数 ：k : Optional[int] = None¶
- 参数 ：n_hits : Optional[int] = None¶
- 参数 ：n_snippets_per_hit : Optional[int] = None¶
- 参数 ：num_web_results : Optional[int] = None¶
- 参数 ：safesearch : Optional[Literal['off', 'moderate', 'strict']] = None¶
- 参数 search_lang: 可选[str] = None¶
- 参数 spellcheck: 可选[bool] = None¶
- 参数 ui_lang: 可选[str] = None¶
- 参数 ydc_api_key: 可选[str] = None¶
- raw_results(query: str, **kwargs: Any) Dict[源代码]¶
通过you.com搜索运行查询并返回命中结果。
- 参数
query (str) – 要搜索的查询。
kwargs (Any) –
- 返回类型
Dict
返回：YouAPIOutput
- async raw_results_async(query: str, **kwargs: Any) Dict[源代码]¶
异步从you.com搜索API获取结果。
- 参数
query (str) –
kwargs (Any) –
- 返回类型
Dict