Skip to content

tool

WebSearchTool

Bases: BaseTool

Source code in griptape/tools/web_search/tool.py 
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
@define
class WebSearchTool(BaseTool):
    web_search_driver: BaseWebSearchDriver = field(kw_only=True)

    @activity(
        config={
            "description": "Can be used for searching the web via the {{ _self.web_search_driver.__class__.__name__}}.",
            "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:
        values = props["values"]
        query = values["query"]
        extra_keys = {k: values[k] for k in values.keys() - {"query"}}

        try:
            return self.web_search_driver.search(query, **extra_keys)
        except Exception as e:
            return ErrorArtifact(f"Error searching '{query}' with {self.web_search_driver.__class__.__name__}: {e}")

web_search_driver: BaseWebSearchDriver = field(kw_only=True) class-attribute instance-attribute

search(props)

Source code in griptape/tools/web_search/tool.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
@activity(
    config={
        "description": "Can be used for searching the web via the {{ _self.web_search_driver.__class__.__name__}}.",
        "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:
    values = props["values"]
    query = values["query"]
    extra_keys = {k: values[k] for k in values.keys() - {"query"}}

    try:
        return self.web_search_driver.search(query, **extra_keys)
    except Exception as e:
        return ErrorArtifact(f"Error searching '{query}' with {self.web_search_driver.__class__.__name__}: {e}")