Skip to content

Tool

WebSearch

Bases: BaseTool

Source code in griptape/tools/web_search/tool.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
@define
class WebSearch(BaseTool):
    results_count: int = field(default=5, kw_only=True)
    google_api_lang: str = field(default="lang_en", kw_only=True)
    google_api_key: str = field(kw_only=True)
    google_api_search_id: str = field(kw_only=True)
    google_api_country: str = field(default="us", kw_only=True)

    @activity(
        config={
            "description": "Can be used for searching the web",
            "schema": Schema(
                {
                    Literal(
                        "query",
                        description="Search engine request that returns a list of pages with titles, descriptions, and URLs",
                    ): str
                }
            ),
        }
    )
    def search(self, props: dict) -> ListArtifact | ErrorArtifact:
        query = props["values"]["query"]

        try:
            return ListArtifact([TextArtifact(str(result)) for result in self._search_google(query)])
        except Exception as e:
            return ErrorArtifact(f"error searching Google: {e}")

    def _search_google(self, query: str) -> list[dict]:
        url = (
            f"https://www.googleapis.com/customsearch/v1?"
            f"key={self.google_api_key}&"
            f"cx={self.google_api_search_id}&"
            f"q={query}&"
            f"start=0&"
            f"lr={self.google_api_lang}&"
            f"num={self.results_count}&"
            f"gl={self.google_api_country}"
        )
        response = requests.get(url)

        if response.status_code == 200:
            data = response.json()

            links = [{"url": r["link"], "title": r["title"], "description": r["snippet"]} for r in data["items"]]

            return links
        else:
            raise Exception(
                f"Google Search API returned an error with status code "
                f"{response.status_code} and reason '{response.reason}'"
            )

google_api_country: str = field(default='us', kw_only=True) class-attribute instance-attribute

google_api_key: str = field(kw_only=True) class-attribute instance-attribute

google_api_lang: str = field(default='lang_en', kw_only=True) class-attribute instance-attribute

google_api_search_id: str = field(kw_only=True) class-attribute instance-attribute

results_count: int = field(default=5, kw_only=True) class-attribute instance-attribute

search(props)

Source code in griptape/tools/web_search/tool.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@activity(
    config={
        "description": "Can be used for searching the web",
        "schema": Schema(
            {
                Literal(
                    "query",
                    description="Search engine request that returns a list of pages with titles, descriptions, and URLs",
                ): str
            }
        ),
    }
)
def search(self, props: dict) -> ListArtifact | ErrorArtifact:
    query = props["values"]["query"]

    try:
        return ListArtifact([TextArtifact(str(result)) for result in self._search_google(query)])
    except Exception as e:
        return ErrorArtifact(f"error searching Google: {e}")