feat: Add Google Search and Google Shopping tools

[tanys123]

Add supports for SerpApi's Google Search and Google Shopping

Google Search Tool

Google Search provides the capability to search information on the internet.

Google Shopping Tool

Google Shopping provides the capability to search shopping listing for given search query

[joaomdmoura]

Disclaimer: This review was made by a crew of AI Agents.

Code Review Comment: SerpApi Tools Integration

Overview

This pull request integrates SerpApi functionalities for Google Search and Google Shopping via the newly created tool classes. Below is a detailed review, including specific improvements, historical context, related file implications, and recommendations for enhancements.

1. SerpApiBaseTool Class Review

File Location: crewai_tools/tools/serpapi_tool/serpapi_base_tool.py

Positive Aspects:

• Inheritance: Efficiently extends BaseTool, promoting code reusability.
• API Key Validation: Well-implemented checks ensure that API key absence is handled gracefully.
• Field Omission: The _omit_fields function provides effective data handling to reduce unnecessary clutter in the responses.

Issues and Suggestions:

1. Error Handling: Improve error messaging in the case of missing SerpApi dependency:

   raise ImportError("`serpapi` package not found, please install with `pip install serpapi`")

2. Type Hints: Add type hints for parameters and return types to enhance code clarity:

   def _omit_fields(self, data: Union[Dict, List], omit_patterns: List[str]) -> None:

3. Documentation: Expand the class and method docstrings to clarify usage and parameters:

   class SerpApiBaseTool(BaseTool):
       """Base class for SerpApi functionality with shared capabilities."""

2. SerpApiGoogleSearchTool Class Review

File Location: crewai_tools/tools/serpapi_tool/serpapi_google_search_tool.py

Issues and Suggestions:

1. Result Processing: Ensure that the absence of results is communicated clearly:

   if not results:
       return {"error": "No results found"}

2. Input Validation: Utilize Pydantic for stricter schema validation that addresses length limits and acceptable formats:

   class SerpApiGoogleSearchToolSchema(BaseModel):
       search_query: str = Field(..., min_length=1, max_length=2048)

3. SerpApiGoogleShoppingTool Class Review

File Location: crewai_tools/tools/serpapi_tool/serpapi_google_shopping_tool.py

Issues and Suggestions:

1. Result Filtering: Incorporate sorting capabilities to enhance user queries:

   "sort_by": kwargs.get("sort_by", "review_score"),

2. Enhanced Schema: Include additional fields for filtering and sorting in the schema to improve user search experience:

   class SerpApiGoogleShoppingToolSchema(BaseModel):
       price_min: Optional[float] = Field(None, description="Minimum price filter")

4. Documentation Review & Enhancements

File Location: crewai_tools/tools/serpapi_tool/README.md

Improvements Suggested:

1. Example Enhancements: Provide comprehensive usage examples that demonstrate result handling:

   from crewai_tools import SerpApiGoogleSearchTool
   
   tool = SerpApiGoogleSearchTool()
   results = tool.run(search_query="Python programming", location="United States")

2. Expanded Documentation: Clarify rate limiting details, error handling strategies, and response structures to enhance usability.

General Recommendations:

1. Unit Tests: Develop a suite of unit tests for all classes to ensure functionality remains intact through future modifications.
2. Response Caching: Implement mechanisms to cache responses and reduce load on the API.
3. Security Measures: Consider adding input validation and sanitization practices to prevent injection attacks.

Security Considerations:

1. Input sanitization: Critical for preventing harmful inputs from users.
2. API Key Rotation and Timeout: These measures will enhance security and reliability when interacting with the SerpApi service.
3. Usage Monitoring: Establish logging to monitor API usage smoothly.

Overall, the integration showcases a well-structured framework with good practices, but with the recommended enhancements, it can achieve even greater performance and security thresholds.

[joaomdmoura]

Good addition!