From 8f151223adee00c39df1b59cc800953ffde8b268 Mon Sep 17 00:00:00 2001 From: Andrew Effendi <84085709+AndrewEffendi@users.noreply.github.com> Date: Wed, 23 Oct 2024 20:18:11 -0400 Subject: [PATCH] Community: Fix DuckDuckGo search tool Output Format (#27479) **Issue:** : https://github.com/langchain-ai/langchain/issues/22961 **Description:** Previously, the documentation for `DuckDuckGoSearchResults` said that it returns a JSON string, however the code returns a regular string that can't be parsed as is. for example running ```python from langchain_community.tools import DuckDuckGoSearchResults # Create a DuckDuckGo search instance search = DuckDuckGoSearchResults() # Invoke the search result = search.invoke("Obama") # Print the result print(result) # Print the type of the result print("Result Type:", type(result)) ``` will return ``` snippet: Harris will hold a campaign event with former President Barack Obama in Georgia next Thursday, the first time the pair has campaigned side by side, a senior campaign official said. A week from ..., title: Obamas to hit the campaign trail in first joint appearances with Harris, link: https://www.nbcnews.com/politics/2024-election/obamas-hit-campaign-trail-first-joint-appearances-harris-rcna176034, snippet: Item 1 of 3 Former U.S. first lady Michelle Obama and her husband, former U.S. President Barack Obama, stand on stage during Day 2 of the Democratic National Convention (DNC) in Chicago, Illinois ..., title: Obamas set to hit campaign trail with Kamala Harris for first time, link: https://www.reuters.com/world/us/obamas-set-hit-campaign-trail-with-kamala-harris-first-time-2024-10-18/, snippet: Barack and Michelle Obama will make their first campaign appearances alongside Kamala Harris at rallies in Georgia and Michigan. By Reid J. Epstein Reporting from Ashwaubenon, Wis. Here come the ..., title: Harris Will Join Michelle Obama and Barack Obama on Campaign Trail, link: https://www.nytimes.com/2024/10/18/us/politics/kamala-harris-michelle-obama-barack-obama.html, snippet: Obama's leaving office was "a turning point," Mirsky said. "That was the last time anybody felt normal." A few feet over, a 64-year-old physics professor named Eric Swanson who had grown ..., title: Obama's reemergence on the campaign trail for Harris comes as he ..., link: https://www.cnn.com/2024/10/13/politics/obama-campaign-trail-harris-biden/index.html Result Type: ``` After the change in this PR, `DuckDuckGoSearchResults` takes an additional `output_format = "list" | "json" | "string"` ("string" = current behavior, default). For example, invoking `DuckDuckGoSearchResults(output_format="list")` return a list of dictionaries in the format ``` [{'snippet': '...', 'title': '...', 'link': '...'}, ...] ``` e.g. ``` [{'snippet': "Obama has in a sense been wrestling with Trump's impact since the real estate magnate broke onto the political stage in 2015. Trump's victory the next year, defeating Obama's secretary of ...", 'title': "Obama's fears about Trump drive his stepped-up campaigning", 'link': 'https://www.washingtonpost.com/politics/2024/10/18/obama-trump-anxiety-harris-campaign/'}, {'snippet': 'Harris will hold a campaign event with former President Barack Obama in Georgia next Thursday, the first time the pair has campaigned side by side, a senior campaign official said. A week from ...', 'title': 'Obamas to hit the campaign trail in first joint appearances with Harris', 'link': 'https://www.nbcnews.com/politics/2024-election/obamas-hit-campaign-trail-first-joint-appearances-harris-rcna176034'}, {'snippet': 'Item 1 of 3 Former U.S. first lady Michelle Obama and her husband, former U.S. President Barack Obama, stand on stage during Day 2 of the Democratic National Convention (DNC) in Chicago, Illinois ...', 'title': 'Obamas set to hit campaign trail with Kamala Harris for first time', 'link': 'https://www.reuters.com/world/us/obamas-set-hit-campaign-trail-with-kamala-harris-first-time-2024-10-18/'}, {'snippet': 'Barack and Michelle Obama will make their first campaign appearances alongside Kamala Harris at rallies in Georgia and Michigan. By Reid J. Epstein Reporting from Ashwaubenon, Wis. Here come the ...', 'title': 'Harris Will Join Michelle Obama and Barack Obama on Campaign Trail', 'link': 'https://www.nytimes.com/2024/10/18/us/politics/kamala-harris-michelle-obama-barack-obama.html'}] Result Type: ``` --------- Co-authored-by: vbarda --- docs/docs/integrations/tools/ddg.ipynb | 62 ++++++++++++++++--- .../tools/ddg_search/tool.py | 53 +++++++++++----- 2 files changed, 89 insertions(+), 26 deletions(-) diff --git a/docs/docs/integrations/tools/ddg.ipynb b/docs/docs/integrations/tools/ddg.ipynb index d436b349cd65b..703d25d5b35de 100644 --- a/docs/docs/integrations/tools/ddg.ipynb +++ b/docs/docs/integrations/tools/ddg.ipynb @@ -14,7 +14,7 @@ }, { "cell_type": "code", - "execution_count": null, + "execution_count": 1, "id": "21e46d4d", "metadata": {}, "outputs": [], @@ -31,7 +31,7 @@ { "data": { "text/plain": [ - "'When Ann Dunham and Barack Obama Sr. tied the knot, they kept the news to themselves. \"Nobody was invited,\" Neil Abercrombie, a college friend of Obama Sr., told Time in 2008. The wedding came as ... As the head of the government of the United States, the president is arguably the most powerful government official in the world. The president is elected to a four-year term via an electoral college system. Since the Twenty-second Amendment was adopted in 1951, the American presidency has been Most common names of U.S. presidents 1789-2021. Published by. Aaron O\\'Neill , Jul 4, 2024. The most common first name for a U.S. president is James, followed by John and then William. Six U.S ... Obama\\'s personal charisma, stirring oratory, and his campaign promise to bring change to the established political system resonated with many Democrats, especially young and minority voters. On January 3, 2008, Obama won a surprise victory in the first major nominating contest, the Iowa caucus, over Sen. Hillary Clinton, who was the overwhelming favorite to win the nomination. Former President Barack Obama released a letter about President Biden\\'s decision to drop out of the 2024 presidential race. Notably, Obama did not name or endorse Vice President Kamala Harris.'" + "\"The White House, official residence of the president of the United States, in July 2008. The president of the United States is the head of state and head of government of the United States, [1] indirectly elected to a four-year term via the Electoral College. [2] The officeholder leads the executive branch of the federal government and is the commander-in-chief of the United States Armed ... Here is a list of the presidents and vice presidents of the United States along with their parties and dates in office. ... Chester A Arthur: Twenty-First President of the United States. 10 Interesting Facts About James Buchanan. Martin Van Buren - Eighth President of the United States. Quotes From Harry S. Truman. 2 of 2. Barack Obama: timeline Key events in the life of Barack Obama. Barack Obama (born August 4, 1961, Honolulu, Hawaii, U.S.) is the 44th president of the United States (2009-17) and the first African American to hold the office. Before winning the presidency, Obama represented Illinois in the U.S. Senate (2005-08). Table of Contents As the head of the government of the United States, the president is arguably the most powerful government official in the world. The president is elected to a four-year term via an electoral college system. Since the Twenty-second Amendment was adopted in 1951, the American presidency has been limited to a maximum of two terms.. Click on a president below to learn more about ... Most common names of U.S. presidents 1789-2021. Published by. Aaron O'Neill, Aug 9, 2024. The most common first name for a U.S. president is James, followed by John and then William. Six U.S ...\"" ] }, "execution_count": 2, @@ -64,7 +64,7 @@ { "data": { "text/plain": [ - "\"[snippet: Why Obama Hasn't Endorsed Harris. The former president has positioned himself as an impartial elder statesman above intraparty machinations and was neutral during the 2020 Democratic primaries., title: Why Obama Hasn't Endorsed Harris - The New York Times, link: https://www.nytimes.com/2024/07/21/us/politics/why-obama-hasnt-endorsed-harris.html], [snippet: Former President Barack Obama released a letter about President Biden's decision to drop out of the 2024 presidential race. Notably, Obama did not name or endorse Vice President Kamala Harris., title: Read Obama's full statement on Biden dropping out - CBS News, link: https://www.cbsnews.com/news/barack-obama-biden-dropping-out-2024-presidential-race-full-statement/], [snippet: USA TODAY. 0:04. 0:48. Former President Barack Obama recently said, in private, that President Joe Biden's chances at a successful presidential run in 2024 have declined and that he needs to ..., title: Did Obama tell Biden to quit? What the former president said - USA TODAY, link: https://www.usatoday.com/story/news/politics/elections/2024/07/18/did-obama-tell-biden-to-quit-what-the-former-president-said/74458139007/], [snippet: Many of the marquee names in Democratic politics began quickly lining up behind Vice President Kamala Harris on Sunday, but one towering presence in the party held back: Barack Obama. The former president has not yet endorsed Harris; in fact, he did not mention her once in an affectionate — if tautly written — tribute to President Joe Biden that was posted on Medium shortly after Biden ..., title: Why Obama Hasn't Endorsed Harris - Yahoo News, link: https://news.yahoo.com/news/why-obama-hasn-t-endorsed-114259092.html]\"" + "\"snippet: He maintains a close friendship with Mr. Obama. He first weighed in on presidential politics to criticize President Reagan's re-election campaign, and has since supported Mr. Obama, Hillary ..., title: Bruce Springsteen to Appear With Harris and Obama at Atlanta and ..., link: https://www.nytimes.com/2024/10/22/us/politics/springsteen-harris-atlanta-obama-philly.html, snippet: Learn about the life and achievements of Barack Obama, the 44th president of the United States and the first African American to hold the office. Explore his early years, education, political career, books, awards, and more., title: Barack Obama | Biography, Parents, Education, Presidency, Books ..., link: https://www.britannica.com/biography/Barack-Obama, snippet: Obama's personal charisma, stirring oratory, and his campaign promise to bring change to the established political system resonated with many Democrats, especially young and minority voters. On January 3, 2008, Obama won a surprise victory in the first major nominating contest, the Iowa caucus, over Sen. Hillary Clinton, who was the overwhelming favorite to win the nomination., title: Barack Obama - 44th President, Political Career, Legacy | Britannica, link: https://www.britannica.com/biography/Barack-Obama/Politics-and-ascent-to-the-presidency, snippet: Former President Barack Obama endorsed Kamala Harris and Tim Walz for president and vice president in his keynote address at the 2024 Democratic National Convention. He criticized Donald Trump's rhetoric and policies, and praised Harris' empathy and decency., title: Watch: Barack Obama's full speech at the 2024 DNC, link: https://www.cbsnews.com/news/watch-barack-obamas-full-speech-2024-dnc-transcript/\"" ] }, "execution_count": 3, @@ -80,6 +80,48 @@ "search.invoke(\"Obama\")" ] }, + { + "cell_type": "markdown", + "id": "aacc1186", + "metadata": {}, + "source": [ + "By default the results are returned as a comma-separated string of key-value pairs from the original search results. You can also choose to return the search results as a list by setting `output_format=\"list\"` or as a JSON string by setting `output_format=\"json\"`." + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "id": "5ac4602d", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "[{'snippet': 'Obama was headed to neighboring Michigan later Tuesday, among the several stops the former president is making in battleground states to encourage early voting. Harris has been spending a lot of time in the \" blue wall \" states of Wisconsin, Michigan and Pennsylvania in the final weeks of the campaign, including stops in Michigan and ...',\n", + " 'title': 'Obama and Walz host rally in Wisconsin as early voting kicks off | AP News',\n", + " 'link': 'https://apnews.com/article/wisconsin-voting-trump-harris-obama-walz-aeeff20ab17a54172263ee4778bed3dc'},\n", + " {'snippet': \"Obama has directed plenty of criticisms at Trump over the years, so some might perceive this as little more than the latest installment in a larger pattern. But let's not be too quick to rush ...\",\n", + " 'title': 'Why Obama slamming Trump on his response to Covid matters - MSNBC',\n", + " 'link': 'https://www.msnbc.com/rachel-maddow-show/maddowblog/obama-slamming-trump-response-covid-matters-rcna176624'},\n", + " {'snippet': 'Learn about the life and achievements of Barack Obama, the 44th president of the United States and the first African American to hold the office. Explore his early years, education, political career, books, awards, and more.',\n", + " 'title': 'Barack Obama | Biography, Parents, Education, Presidency, Books ...',\n", + " 'link': 'https://www.britannica.com/biography/Barack-Obama'},\n", + " {'snippet': \"He maintains a close friendship with Mr. Obama. He first weighed in on presidential politics to criticize President Reagan's re-election campaign, and has since supported Mr. Obama, Hillary ...\",\n", + " 'title': 'Bruce Springsteen to Appear With Harris and Obama at Atlanta and ...',\n", + " 'link': 'https://www.nytimes.com/2024/10/22/us/politics/springsteen-harris-atlanta-obama-philly.html'}]" + ] + }, + "execution_count": 4, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "search = DuckDuckGoSearchResults(output_format=\"list\")\n", + "\n", + "search.invoke(\"Obama\")" + ] + }, { "cell_type": "markdown", "id": "e17ccfe7", @@ -90,17 +132,17 @@ }, { "cell_type": "code", - "execution_count": 4, + "execution_count": 5, "id": "21afe28d", "metadata": {}, "outputs": [ { "data": { "text/plain": [ - "'[snippet: Users on X have been widely comparing the boost of support felt for Kamala Harris\\' campaign to Barack Obama\\'s in 2008., title: Surging Support For Kamala Harris Compared To Obama-Era Energy, link: https://www.msn.com/en-us/news/politics/surging-support-for-kamala-harris-compared-to-obama-era-energy/ar-BB1qzdC0, date: 2024-07-24T18:27:01+00:00, source: Newsweek on MSN.com], [snippet: Harris tried to emulate Obama\\'s coalition in 2020 and failed. She may have a better shot at reaching young, Black, and Latino voters this time around., title: Harris May Follow Obama\\'s Path to the White House After All, link: https://www.msn.com/en-us/news/politics/harris-may-follow-obama-s-path-to-the-white-house-after-all/ar-BB1qv9d4, date: 2024-07-23T22:42:00+00:00, source: Intelligencer on MSN.com], [snippet: The Republican presidential candidate said in an interview on Fox News that he \"wouldn\\'t be worried\" about Michelle Obama running., title: Donald Trump Responds to Michelle Obama Threat, link: https://www.msn.com/en-us/news/politics/donald-trump-responds-to-michelle-obama-threat/ar-BB1qqtu5, date: 2024-07-22T18:26:00+00:00, source: Newsweek on MSN.com], [snippet: H eading into the weekend at his vacation home in Rehoboth Beach, Del., President Biden was reportedly stewing over Barack Obama\\'s role in the orchestrated campaign to force him, title: Opinion | Barack Obama Strikes Again, link: https://www.msn.com/en-us/news/politics/opinion-barack-obama-strikes-again/ar-BB1qrfiy, date: 2024-07-22T21:28:00+00:00, source: The Wall Street Journal on MSN.com]'" + "\"snippet: Springsteen, a longtime Democratic activist, will be joined by former President Barack Obama at both shows, with Harris scheduled to attend the Atlanta concert. Springsteen, a New Jersey native, has maintained a deep connection with Philadelphia throughout his career., title: Bruce Springsteen to hold battleground concerts with Kamala Harris, Barack Obama, link: https://www.statesman.com/story/news/politics/elections/2024/10/22/springsteen-obama-2024-concerts-harris/75791934007/, date: 2024-10-22T20:45:00+00:00, source: Austin American-Statesman, snippet: Obama roasts Trump's bible: 'He's Mr. Tough Guy on China except when it comes to making a few bucks', title: Obama roasts Trump's bible: 'He's Mr. Tough Guy on China except when it comes to making a few bucks', link: https://www.msnbc.com/deadline-white-house/watch/obama-roasts-trump-he-s-mr-tough-guy-on-china-except-when-it-comes-to-making-a-few-bucks-222399557750, date: 2024-10-22T20:28:00+00:00, source: MSNBC, snippet: Democratic nominee and Vice President Kamala Harris is sending a potentially powerful closer to Detroit today to shore up her standing in Michigan: Former President Barack Obama. The campaign has been notably mum on exactly when and where Obama is speaking but as he hits the campaign trail on behalf of his fellow Democrat,, title: Watch live tonight: Former President Obama to rally for Kamala Harris in Detroit, link: https://www.msn.com/en-us/news/politics/watch-live-tonight-former-president-obama-to-rally-for-kamala-harris-in-detroit/ar-AA1sJpiB, date: 2024-10-22T18:32:26+00:00, source: Detroit Free Press on MSN.com, snippet: During a campaign rally in Wisconsin, former President Obama called into question former President Trump's mental fitness and joked about him ending a town hall to listen to music with attendees., title: 'Our playlist would be better': Obama jokes about Trump listening to music at town hall, link: https://www.msnbc.com/msnbc/watch/obama-jokes-about-trump-ending-town-hall-to-listen-to-music-222399045983, date: 2024-10-22T20:31:00+00:00, source: MSNBC\"" ] }, - "execution_count": 4, + "execution_count": 5, "metadata": {}, "output_type": "execute_result" } @@ -121,17 +163,17 @@ }, { "cell_type": "code", - "execution_count": 5, + "execution_count": 6, "id": "c7ab3b55", "metadata": {}, "outputs": [ { "data": { "text/plain": [ - "'[snippet: So war das zum Beispiel bei Barack Obama, als er sich für Joe Biden als Kandidat für die Vizepräsidentschaft entschied. USA-Expertin Rachel Tausendfreund erklärt, wie sich Kamala Harris als ..., title: Interview: „Kamala Harris sieht die Welt eher wie Barack Obama - nicht ..., link: https://www.handelsblatt.com/politik/interview-kamala-harris-sieht-die-welt-eher-wie-barack-obama-nicht-wie-joe-biden/100054923.html], [snippet: Disput um Klimapolitik Der seltsame Moment, als Kamala Harris sogar Obama vor Gericht zerrte. Teilen. 0. Chip Somodevilla/Getty Images US-Vizepräsidentin Kamala Harris (links) und Ex-Präsident ..., title: Der seltsame Moment, als Kamala Harris sogar Obama vor Gericht zerrte, link: https://www.focus.de/earth/analyse/disput-um-klimapolitik-der-seltsame-moment-als-kamala-harris-sogar-obama-vor-gericht-zerrte_id_260165157.html], [snippet: Kamala Harris «Auf den Spuren von Obama»: Harris\\' erste Rede überzeugt Experten. Kamala Harris hat ihre erste Rede als Präsidentschaftskandidatin gehalten. Zwei Experten sind sich einig: Sie ..., title: Kamala Harris\\' erste Wahlkampfrede überzeugt Experten, link: https://www.20min.ch/story/kamala-harris-auf-den-spuren-von-obama-harris-erste-rede-ueberzeugt-experten-103154550], [snippet: Harris hat ihre erste Rede als Präsidentschaftskandidatin gehalten. Experten sind sich einig: Sie hat das Potenzial, ein Feuer zu entfachen wie Obama., title: \"Auf Spuren von Obama\": Harris-Rede überzeugt Experten, link: https://www.heute.at/s/auf-spuren-von-obama-harris-rede-ueberzeugt-experten-120049557]'" + "'snippet: 22.10.2024, 18.21 Uhr. 1. Macht der Worte. Der beste Redner der US-Politik: Obama in Tucson. Foto: Mamta Popat / Arizona Daily Star / AP / dpa. Politik ist Sprache. Das wussten die Jakobiner im ..., title: News des Tages: Barack Obama und Donald Trump, Elon Musk, Herbert Kickl, link: https://www.spiegel.de/politik/deutschland/news-des-tages-barack-obama-und-donald-trump-elon-musk-herbert-kickl-a-c1a76de5-f9aa-4038-a1ad-f426b85267f8, snippet: Oct. 22, 2024, 12:38 p.m. ET. The rocker Bruce Springsteen will perform at a rally on Thursday in Atlanta, appearing alongside Vice President Kamala Harris and former President Barack Obama, as ..., title: Bruce Springsteen to Appear With Harris and Obama at Atlanta and ..., link: https://www.nytimes.com/2024/10/22/us/politics/springsteen-harris-atlanta-obama-philly.html, snippet: In-person early voting has kicked off across battleground Wisconsin, with former President Barack Obama and Democratic vice presidential nominee Tim Walz hosting a rally in liberal Madison, title: Watch live: Barack Obama and VP nominee Tim Walz hold rally in ..., link: https://news.sky.com/video/watch-live-barack-obama-and-and-vp-nominee-tim-walz-hold-rally-in-wisconsin-13239026, snippet: Barack Obama will speak to a campaign rally for Kamala Harris in Madison, Wisconsin this afternoon. The former US president was expected to be joined by Tim Walz, the Democratic vice presidential ..., title: Obama-Walz rally live: Former president campaigns for Harris in Madison, link: https://www.telegraph.co.uk/us/politics/2024/10/22/obama-walz-rally-campaigns-kamala-harris-madison-wisconsin/'" ] }, - "execution_count": 5, + "execution_count": 6, "metadata": {}, "output_type": "execute_result" } @@ -173,7 +215,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.5" + "version": "3.12.3" }, "vscode": { "interpreter": { diff --git a/libs/community/langchain_community/tools/ddg_search/tool.py b/libs/community/langchain_community/tools/ddg_search/tool.py index f2889daa716b2..7db9b77da4273 100644 --- a/libs/community/langchain_community/tools/ddg_search/tool.py +++ b/libs/community/langchain_community/tools/ddg_search/tool.py @@ -1,7 +1,8 @@ """Tool for the DuckDuckGo search API.""" +import json import warnings -from typing import Any, List, Optional, Type +from typing import Any, List, Literal, Optional, Type, Union from langchain_core.callbacks import CallbackManagerForToolRun from langchain_core.tools import BaseTool @@ -74,14 +75,14 @@ def _run( class DuckDuckGoSearchResults(BaseTool): - """Tool that queries the DuckDuckGo search API and gets back json string.""" + """Tool that queries the DuckDuckGo search API and + returns the results in `output_format`.""" name: str = "duckduckgo_results_json" description: str = ( "A wrapper around Duck Duck Go Search. " "Useful for when you need to answer questions about current events. " - "Input should be a search query. Output is a JSON string array of the " - "query results" + "Input should be a search query." ) max_results: int = Field(alias="num_results", default=4) api_wrapper: DuckDuckGoSearchAPIWrapper = Field( @@ -93,25 +94,45 @@ class DuckDuckGoSearchResults(BaseTool): """Which keys from each result to include. If None all keys are included.""" results_separator: str = ", " """Character for separating results.""" + output_format: Literal["string", "json", "list"] = "string" + """Output format of the search results. + + - 'string': Return a concatenated string of the search results. + - 'json': Return a JSON string of the search results. + - 'list': Return a list of dictionaries of the search results. + """ + response_format: Literal["content_and_artifact"] = "content_and_artifact" def _run( self, query: str, run_manager: Optional[CallbackManagerForToolRun] = None, - ) -> str: + ) -> tuple[Union[List[dict], str], List[dict]]: """Use the tool.""" - res = self.api_wrapper.results(query, self.max_results, source=self.backend) - res_strs = [ - ", ".join( - [ - f"{k}: {v}" - for k, v in d.items() - if not self.keys_to_include or k in self.keys_to_include - ] - ) - for d in res + raw_results = self.api_wrapper.results( + query, self.max_results, source=self.backend + ) + results = [ + { + k: v + for k, v in d.items() + if not self.keys_to_include or k in self.keys_to_include + } + for d in raw_results ] - return self.results_separator.join(res_strs) + + if self.output_format == "list": + return results, raw_results + elif self.output_format == "json": + return json.dumps(results), raw_results + elif self.output_format == "string": + res_strs = [", ".join([f"{k}: {v}" for k, v in d.items()]) for d in results] + return self.results_separator.join(res_strs), raw_results + else: + raise ValueError( + f"Invalid output_format: {self.output_format}. " + "Needs to be one of 'string', 'json', 'list'." + ) def DuckDuckGoSearchTool(*args: Any, **kwargs: Any) -> DuckDuckGoSearchRun: