Merge branch 'main' into add-more-parameters-to-serperdev-search-payload

src/crewai_tools/tools/serper_dev_tool/serper_dev_tool.py

@@ -6,6 +6,14 @@ from typing import Optional, Type, Any
 from pydantic.v1 import BaseModel, Field
 from crewai_tools.tools.base_tool import BaseTool
 
+def _save_results_to_file(content: str) -> None:
+    """Saves the search results to a file."""
+    filename = f"search_results_{datetime.now().strftime('%Y-%m-%d_%H-%M-%S')}.txt"
+    with open(filename, 'w') as file:
+        file.write(content)
+    print(f"Results saved to {filename}")
+
+
 class SerperDevToolSchema(BaseModel):
 	"""Input for SerperDevTool."""
 	search_query: str = Field(..., description="Mandatory search query you want to use to search the internet")
@@ -15,26 +23,31 @@ class SerperDevTool(BaseTool):
 	description: str = "A tool that can be used to search the internet with a search_query."
 	args_schema: Type[BaseModel] = SerperDevToolSchema
 	search_url: str = "https://google.serper.dev/search"
-	n_results: int = 10
 	country: Optional[str] = None
 	location: Optional[str] = None
 	locale: Optional[str] = None
+	n_results: int = Field(default=10, description="Number of search results to return")
+  save_file: bool = Field(default=False, description="Flag to determine whether to save the results to a file")
 
 	def _run(
 		self,
 		**kwargs: Any,
 	) -> Any:
+
 		search_query = kwargs.get('search_query') or kwargs.get('query')
+    save_file = kwargs.get('save_file', self.save_file)
+    n_results = kwargs.get('n_results', self.n_results)
 
 		payload = json.dumps(
 			{
 				"q": search_query,
-				"num": self.n_results,
+				"num": n_results,
 				"gl": self.country,
 				"location": self.location,
 				"hl": self.locale,
 			}
 		)
+
 		headers = {
 			'X-API-KEY': os.environ['SERPER_API_KEY'],
 				'content-type': 'application/json'
@@ -42,7 +55,7 @@ class SerperDevTool(BaseTool):
 		response = requests.request("POST", self.search_url, headers=headers, data=payload)
 		results = response.json()
 		if 'organic' in results:
-			results = results['organic']
+			results = results['organic'][:self.n_results]
 			string = []
 			for result in results:
 				try:
@@ -53,9 +66,11 @@ class SerperDevTool(BaseTool):
 							"---"
 					]))
 				except KeyError:
-					next
+					continue
 
 			content = '\n'.join(string)
+			if save_file:
+                		_save_results_to_file(content)
 			return f"\nSearch results: {content}\n"
 		else:
 			return results