langchain_community.utilities.google_search.GoogleSearchAPIWrapper¶
- class langchain_community.utilities.google_search.GoogleSearchAPIWrapper[source]¶
Bases:
BaseModel[Deprecated] 包装了Google搜索API。
改编自：从https://stackoverflow.com/questions/ 37083058/ 改编的指令
待办事项：使用文档 1. 安装google-api-python-client - 如果您还没有Google账号，请注册。 - 如果您从未创建过Google APIs控制台项目，请阅读管理项目页面并在Google API控制台中创建项目。 - 使用pip install google-api-python-client安装库
2. 启用自定义搜索API - 转到Cloud Console中的API和服务→仪表板面板。 - 点击启用API和服务。 - 搜索Custom Search API并点击它。 - 点击启用。 URL：https://console.cloud.google.com/apis/library/customsearch.googleapis .com
3. 创建API密钥： - 转到Cloud Console中的API和服务 → 凭据面板。 - 选择创建凭据，然后从下拉菜单中选择API密钥。 - API密钥创建对话框显示您新创建的密钥。 - 您现在有一个API_KEY
或者，您可以在此处生成API密钥： https://developers.google.com/custom-search/docs/paid_element#api_key
4. 设置自定义搜索引擎，以便搜索整个网络 - 在此处创建自定义搜索引擎：https://programmablesearchengine.google.com/。 - 在“搜索内容”中选择“搜索整个网络”选项。 创建搜索引擎后，您可以单击它并在概述页面上找到“搜索引擎ID”。
Notes
Deprecated since version 0.0.33.
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 google_api_key: Optional[str] = None¶
- param google_cse_id: Optional[str] = None¶
- param k: int = 10¶
- param siterestrict: bool = False¶
- 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, search_params: Optional[Dict[str, str]] = None) List[Dict][source]¶
运行查询通过GoogleSearch并返回元数据。
- 参数：
query：要搜索的查询。 num_results：要返回的结果数量。 search_params：要传递的搜索参数。
- 返回：
- 一个包含以下键的字典列表：
snippet - 结果的描述。 title - 结果的标题。 link - 结果的链接。
- Parameters
query (str) –
num_results (int) –
search_params (Optional[Dict[str, str]]) –
- Return type
List[Dict]
- 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