o Zhb@sjdZddlmZmZmZmZddlmZddlm Z ddl m Z m Z m Z edddd Gd d d e Zd S) zUtil that calls Google Search.)AnyDictListOptional) deprecated)get_from_dict_or_env) BaseModel ConfigDictmodel_validatorz0.0.33z1.0z1langchain_google_community.GoogleSearchAPIWrapper)ZsinceZremovalZalternative_importc @seZdZUdZdZeed<dZee ed<dZ ee ed<dZ e ed<dZ eed <ed d Zd e d edeefddZeddededefddZde de fddZ dde de deee e fdeefddZdS)GoogleSearchAPIWrapperuYWrapper 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. N search_enginegoogle_api_key google_cse_id kF siterestrictZforbid)extra search_termkwargsreturncKs@|j}|jr |}|jd||jd|}|dgS)N)qZcxitems)r cserlistrexecuteget)selfrrrresrrb/var/www/html/lang_env/lib/python3.10/site-packages/langchain_community/utilities/google_search.py_google_search_results@s  z-GoogleSearchAPIWrapper._google_search_resultsbefore)modevaluescCsjt|dd}||d<t|dd}||d<zddlm}Wn ty'tdw|dd |d }||d <|S) z?Validate that api key and python package exists in environment.r ZGOOGLE_API_KEYrZ GOOGLE_CSE_IDr)buildzqgoogle-api-python-client is not installed. Please install it with `pip install google-api-python-client>=2.100.0`Z customsearchv1)Z developerKeyr )rZgoogleapiclient.discoveryr$ ImportError)clsr#r rr$Zservicerrrvalidate_environmentGs   z+GoogleSearchAPIWrapper.validate_environmentquerycCsNg}|j||jd}t|dkrdS|D] }d|vr!||dqd|S)z0Run query through GoogleSearch and parse result.)numr&No good Google Search Result was foundsnippet )r rlenappendjoin)rr)Zsnippetsresultsresultrrrrunbs  zGoogleSearchAPIWrapper.run num_results search_paramscCsrg}|j|fd|i|p i}t|dkrddigS|D]}|d|dd}d|vr1|d|d<||q|S) aRun query through GoogleSearch and return metadata. Args: query: The query to search for. num_results: The number of results to return. search_params: Parameters to be passed on search Returns: A list of dictionaries with the following keys: snippet - The description of the result. title - The title of the result. link - The link to the result. r*rResultr+titlelink)r7r8r,)r r.r/)rr)r4r5Zmetadata_resultsr1r2Zmetadata_resultrrrr1ns$    zGoogleSearchAPIWrapper.results)N)__name__ __module__ __qualname____doc__r r__annotations__r rstrrrintrboolr Z model_configrdictr r classmethodrr(r3r1rrrrr s2  &  r N)r<typingrrrrZlangchain_core._api.deprecationrZlangchain_core.utilsrZpydanticrr r r rrrrs