Add Agentql Tool Integration

agentstack/templates/crewai/tools/agentql_tool.py

@@ -0,0 +1,113 @@
+import os
+import httpx
+
+from pydantic import BaseModel, Field
+from typing import Optional, Type
+
+from crewai_tools import BaseTool
+
+from dotenv import load_dotenv
+load_dotenv()
+
+QUERY_DATA_ENDPOINT = "https://api.agentql.com/v1/query-data"
+API_TIMEOUT_SECONDS = 900
+
+API_KEY = os.getenv("AGENTQL_API_KEY")
+
+class AgentQLQueryDataSchema(BaseModel):
+    url: str = Field(description="Website URL")
+    query: Optional[str] = Field(
+        default=None,
+        description="""
+AgentQL query to scrape the url.
+
+Here is a guide on AgentQL query syntax:
+
+Enclose all AgentQL query terms within curly braces `{}`. The following query structure isn't valid because the term "social\_media\_links" is wrongly enclosed within parenthesis `()`.
+
+```
+( # Should be {
+    social_media_links(The icons that lead to Facebook, Snapchat, etc.)[]
+) # Should be }
+```
+
+The following query is also invalid since its missing the curly braces `{}`
+
+```
+# should include {
+social_media_links(The icons that lead to Facebook, Snapchat, etc.)[]
+# should include }
+```
+
+You can't include new lines in your semantic context. The following query structure isn't valid because the semantic context isn't contained within one line.
+
+```
+{
+    social_media_links(The icons that lead
+        to Facebook, Snapchat, etc.)[]
+}
+```
+"""
+    )
+    prompt: Optional[str] = Field(
+        default=None,
+        description="Natural language description of the data you want to scrape"
+    )
+
+class AgentQLQueryDataTool(BaseTool):
+    name: str = "query_data"
+    description: str = "Scrape a url with a given AgentQL query or a natural language description of the data you want to scrape."
+    args_schema: Type[BaseModel] = AgentQLQueryDataSchema
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+    def _run(
+        self,
+        url: str,
+        query: Optional[str] = None,
+        prompt: Optional[str] = None
+    ) -> dict:
+        payload = {
+            "url": url,
+            "query": query,
+            "prompt": prompt
+        }
+
+        headers = {
+            "X-API-Key": f"{API_KEY}",
+            "Content-Type": "application/json"
+        }
+
+        try:
+            response = httpx.post(
+                QUERY_DATA_ENDPOINT, 
+                headers=headers, 
+                json=payload, 
+                timeout=API_TIMEOUT_SECONDS
+            )
+            response.raise_for_status()
+
+        except httpx.HTTPStatusError as e:
+            response = e.response
+            if response.status_code in [401, 403]:
+                raise ValueError("Please, provide a valid API Key. You can create one at https://dev.agentql.com.") from e
+            else:
+                try:
+                    error_json = response.json()
+                    msg = error_json["error_info"] if "error_info" in error_json else error_json["detail"]
+                except (ValueError, TypeError):
+                    msg = f"HTTP {e}."
+                raise ValueError(msg) from e
+        else:
+            json = response.json()
+            return json["data"]
+
+def createTool(func):
+    def wrapper(*args, **kwargs):
+        return func(*args, **kwargs)
+    return wrapper()
+
+@createTool
+def query_data():
+    return AgentQLQueryDataTool()

agentstack/tools/agentql.json

@@ -0,0 +1,11 @@
+{
+    "name": "agentql",
+    "url": "https://agentql.com/",
+    "category": "web-retrieval",
+    "packages": [],
+    "env": {
+        "AGENTQL_API_KEY": "..."
+    },
+    "tools": ["query_data"],
+    "cta": "Create your AgentQL API key at https://dev.agentql.com"
+}