o Zh@sdZddlmZmZmZmZddlmZddlm Z ddl m Z ddl m Z mZmZGddde ZGd d d e ZGd d d e Zd S)zUtil that calls Google Search.)AnyDictListOptional)CallbackManagerForToolRun)BaseTool)get_from_dict_or_env) BaseModel ConfigDictmodel_validatorc @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)selfrrrresrrX/var/www/html/lang_env/lib/python3.10/site-packages/langchain_google_community/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.rZGOOGLE_API_KEYrZ GOOGLE_CSE_IDr)buildzjgoogle-api-python-client is not installed. Please install it with `pip install langchain-google-community`Z customsearchv1)Z developerKeyr )rZgoogleapiclient.discoveryr% ImportError)clsr$rrr%Zservicerrr validate_environmentCs   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*Zsnippetsresultsresultrrr run]s  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)r8r9r-)r!r/r0)rr*r5r6Zmetadata_resultsr2r3Zmetadata_resultrrr r2is$    zGoogleSearchAPIWrapper.resultsN)__name__ __module__ __qualname____doc__r r__annotations__rrstrrrintrboolr Z model_configrdictr!r classmethodrr)r4r2rrrr r s2  &  r c@sPeZdZUdZdZeed<dZeed<eed< d ded e e d efd d Z dS)GoogleSearchRunz(Tool that queries the Google search API.Z google_searchnamezA wrapper around Google Search. Useful for when you need to answer questions about current events. Input should be a search query. description api_wrapperNr* run_managerrcCs |j|Sz Use the tool.)rHr4rr*rIrrr _runs zGoogleSearchRun._runr:) r;r<r=r>rFr@r?rGr rrrLrrrr rEs   rEc@s\eZdZUdZdZeed<dZeed<dZe ed<e ed< dd ed e e d efd dZ d S)GoogleSearchResultsz;Tool that queries the Google Search API and gets back json.Zgoogle_search_results_jsonrFzA wrapper around Google Search. Useful for when you need to answer questions about current events. Input should be a search query. Output is a JSON array of the query resultsrGr5rHNr*rIrcCst|j||jSrJ)r@rHr2r5rKrrr rLszGoogleSearchResults._runr:)r;r<r=r>rFr@r?rGr5rAr rrrLrrrr rMs   rMN)r>typingrrrrZlangchain_core.callbacksrZlangchain_core.toolsrZlangchain_core.utilsrZpydanticr r r r rErMrrrr s