langchain_google_community.search.GoogleSearchAPIWrapper

class langchain_google_community.search.GoogleSearchAPIWrapper[source]

继承: BaseModel

Google 搜索 API 的包装器。

改编自:从 https://stackoverflow.com/questions/37083058/programmatically-searching-google-in-python-using-custom-search 翻译而来

待办事项:关于如何使用的文档 1. 安装 google-api-python-client - 如果您还没有 Google 账户,请注册。 - 如果您从未创建过 Google 仪表板项目,请阅读“管理项目”页面并在 Google API 仪表板中创建一个项目。 - 使用 pip install google-api-python-client 命令安装库。

2. 启用自定义搜索 API - 在云控制台中,转到“API & 服务”→“仪表板”面板。 - 点击“启用 API 和服务”。 - 搜索“自定义搜索 API”并点击它。 - 点击“启用”。API 的 URL:https://console.cloud.google.com/apis/library/customsearch.googleapis.com

3. 创建 API 密钥: - 在云控制台中,转到“API & 服务”→“凭据”面板。 - 选择“创建凭证”,然后在下拉菜单中选择“API 密钥”。 - 创建的 API 密钥对话框显示您新创建的密钥。 - 您现在有一个 API_KEY

或者,您可以直接在这里生成 API 密钥:https://developers.google.com/custom-search/docs/paid_element#api_key

4. 设置自定义搜索引擎,以便您可以搜索整个网络 - 在这里创建自定义搜索引擎:https://programmablesearchengine.google.com/。 - 在“要搜索的内容”中选择“搜索整个网络”选项。创建搜索引擎后,您可以点击它并找到“搜索引擎 ID”

在概览页面。

通过解析和验证来自关键字参数的输入数据来创建新的模型。

如果输入数据无法被解析为一个有效的模型,则抛出 ValidationError 异常。

参数 google_api_key: str,可选 = None
参数 google_cse_id: str,可选 = None
参数 k : int = 10
参数 siterestrict: bool = False
results(query: str, num_results: int, search_params: Optional[Dict[str, str]] = None) List[Dict][source]

通过GoogleSearch执行查询并返回元数据。

参数
  • query (str) – 要搜索的查询。

  • num_results (int) – 返回的结果数量。

  • search_params (Optional[Dict[str, str]]) – 要在搜索中传递的参数

返回值

片段 - 结果的描述。标题 - 结果的标题。链接 - 结果的链接。

返回类型

包含以下键的字典列表

run(query: str) str[source]

通过GoogleSearch执行查询并解析结果。

参数

query (str) –

返回类型

str

使用GoogleSearchAPIWrapper的示例