U h8@sfdZddlmZmZmZmZddlmZddlm Z m Z ddl m Z edddd Gd d d e Z d S) zUtil that calls Google Search.)AnyDictListOptional) deprecated) BaseModelroot_validator)get_from_dict_or_envz0.0.33z1.0z1langchain_google_community.GoogleSearchAPIWrapper)ZsinceZremovalZalternative_importc@seZdZUdZeed<dZeeed<dZ eeed<dZ e ed<dZ e ed <Gd d d Zeeeed d dZeddeedddZeedddZdee eeeefeedddZdS)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. search_engineNgoogle_api_key google_cse_id kF siterestrictc@seZdZdZdS)zGoogleSearchAPIWrapper.ConfigZforbidN)__name__ __module__ __qualname__extrarrO/tmp/pip-unpacked-wheel-9gdii04g/langchain_community/utilities/google_search.pyConfig<sr) search_termkwargsreturncKs@|j}|jr|}|jf||jd|}|dgS)N)qZcxitems)r cserlistr executeget)selfrrrresrrr_google_search_results?s  z-GoogleSearchAPIWrapper._google_search_resultsT)pre)valuesrcCspt|dd}||d<t|dd}||d<zddlm}Wntk rTtdYnX|dd |d }||d <|S) z?Validate that api key and python package exists in environment.r ZGOOGLE_API_KEYr Z GOOGLE_CSE_IDr)buildzqgoogle-api-python-client is not installed. Please install it with `pip install google-api-python-client>=2.100.0`Z customsearchZv1)Z developerKeyr )r Zgoogleapiclient.discoveryr& ImportError)clsr%r r r&Zservicerrrvalidate_environmentFs"  z+GoogleSearchAPIWrapper.validate_environment)queryrcCsNg}|j||jd}t|dkr$dS|D]}d|kr(||dq(d|S)z0Run query through GoogleSearch and parse result.)numr&No good Google Search Result was foundsnippet )r#rlenappendjoin)r!r*Zsnippetsresultsresultrrrrun`s zGoogleSearchAPIWrapper.run)r* num_results search_paramsrcCsrg}|j|fd|i|pi}t|dkr4ddigS|D]4}|d|dd}d|krb|d|d<||q8|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+rZResultr,titlelink)r7r8r-)r#r/r0)r!r*r5r6Zmetadata_resultsr2r3Zmetadata_resultrrrr2ls$    zGoogleSearchAPIWrapper.results)N)rrr__doc__r__annotations__r rstrr rintrboolrrdictr#rrr)r4r2rrrrr s$ &  r N)r9typingrrrrZlangchain_core._api.deprecationrZlangchain_core.pydantic_v1rrZlangchain_core.utilsr r rrrrs