langchain_community.utilities.google_search.GoogleSearchAPIWrapper

class langchain_community.utilities.google_search.GoogleSearchAPIWrapper

Bases: BaseModel

[Deprecated] Wrapper for Google Search API.

Adapted from: Instructions adapted from https://stackoverflow.com/questions/ 37083058/ programmatically-searching-google-in-python-using-custom-search

TODO: DOCS for using it 1. Install google-api-python-client - If you don’t already have a Google account, sign up. - If you have never created a Google APIs Console project, read the Managing Projects page and create a project in the Google API Console. - Install the library using pip install google-api-python-client

2. Enable the Custom Search API - Navigate to the APIs & Services→Dashboard panel in Cloud Console. - Click Enable APIs and Services. - Search for Custom Search API and click on it. - Click Enable. URL for it: https://console.cloud.google.com/apis/library/customsearch.googleapis .com

3. To create an API key: - Navigate to the APIs & Services → Credentials panel in Cloud Console. - Select Create credentials, then select API key from the drop-down menu. - The API key created dialog box displays your newly created key. - You now have an API_KEY

Alternatively, you can just generate an API key here: https://developers.google.com/custom-search/docs/paid_element#api_key

4. Setup Custom Search Engine so you can search the entire web - Create a custom search engine here: https://programmablesearchengine.google.com/. - In What to search to search, pick the Search the entire Web option. After search engine is created, you can click on it and find Search engine ID

on the Overview page.

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]

Run query through GoogleSearch and return metadata.

Parameters

• query (str) – The query to search for.

• num_results (int) – The number of results to return.

• search_params (Optional[Dict[str, str]]) – Parameters to be passed on search

Returns

snippet - The description of the result. title - The title of the result. link - The link to the result.

Return type

A list of dictionaries with the following keys

run(query: str) → str

Run query through GoogleSearch and parse result.

Parameters

query (str) –

Return type

str

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 GoogleSearchAPIWrapper

• Google

• Set env var OPENAI_API_KEY or load from a .env file:

• System parameter in NIBittensorLLM is optional but you can set whatever you want to perform with model

• agent_with_memory.md

• google_search.md