Squashed 'packages/tools/' content from commit 78317b9c

git-subtree-dir: packages/tools
git-subtree-split: 78317b9c127f18bd040c1d77e3c0840cdc9a5b38

crewai_tools/tools/json_search_tool/README.md

@@ -0,0 +1,55 @@
+# JSONSearchTool
+
+## Description
+This tool is used to perform a RAG search within a JSON file's content. It allows users to initiate a search with a specific JSON path, focusing the search operation within that particular JSON file. If the path is provided at initialization, the tool restricts its search scope to the specified JSON file, thereby enhancing the precision of search results.
+
+## Installation
+Install the crewai_tools package by executing the following command in your terminal:
+
+```shell
+pip install 'crewai[tools]'
+```
+
+## Example
+Below are examples demonstrating how to use the JSONSearchTool for searching within JSON files. You can either search any JSON content or restrict the search to a specific JSON file.
+
+```python
+from crewai_tools import JSONSearchTool
+
+# Example 1: Initialize the tool for a general search across any JSON content. This is useful when the path is known or can be discovered during execution.
+tool = JSONSearchTool()
+
+# Example 2: Initialize the tool with a specific JSON path, limiting the search to a particular JSON file.
+tool = JSONSearchTool(json_path='./path/to/your/file.json')
+```
+
+## Arguments
+- `json_path` (str): An optional argument that defines the path to the JSON file to be searched. This parameter is only necessary if the tool is initialized without a specific JSON path. Providing this argument restricts the search to the specified JSON file.
+
+## Custom model and embeddings
+
+By default, the tool uses OpenAI for both embeddings and summarization. To customize the model, you can use a config dictionary as follows:
+
+```python
+tool = JSONSearchTool(
+    config=dict(
+        llm=dict(
+            provider="ollama", # or google, openai, anthropic, llama2, ...
+            config=dict(
+                model="llama2",
+                # temperature=0.5,
+                # top_p=1,
+                # stream=true,
+            ),
+        ),
+        embedder=dict(
+            provider="google",
+            config=dict(
+                model="models/embedding-001",
+                task_type="retrieval_document",
+                # title="Embeddings",
+            ),
+        ),
+    )
+)
+```

crewai_tools/tools/json_search_tool/json_search_tool.py

@@ -0,0 +1,47 @@
+from typing import Optional, Type
+
+from pydantic import BaseModel, Field
+
+from ..rag.rag_tool import RagTool
+
+
+class FixedJSONSearchToolSchema(BaseModel):
+    """Input for JSONSearchTool."""
+
+    search_query: str = Field(
+        ...,
+        description="Mandatory search query you want to use to search the JSON's content",
+    )
+
+
+class JSONSearchToolSchema(FixedJSONSearchToolSchema):
+    """Input for JSONSearchTool."""
+
+    json_path: str = Field(
+        ..., description="File path or URL of a JSON file to be searched"
+    )
+
+
+class JSONSearchTool(RagTool):
+    name: str = "Search a JSON's content"
+    description: str = (
+        "A tool that can be used to semantic search a query from a JSON's content."
+    )
+    args_schema: Type[BaseModel] = JSONSearchToolSchema
+
+    def __init__(self, json_path: Optional[str] = None, **kwargs):
+        super().__init__(**kwargs)
+        if json_path is not None:
+            self.add(json_path)
+            self.description = f"A tool that can be used to semantic search a query the {json_path} JSON's content."
+            self.args_schema = FixedJSONSearchToolSchema
+            self._generate_description()
+
+    def _run(
+        self,
+        search_query: str,
+        json_path: Optional[str] = None,
+    ) -> str:
+        if json_path is not None:
+            self.add(json_path)
+        return super()._run(query=search_query)