Skip to content

WebSearchTool

autogen.beta.tools.builtin.web_search.WebSearchTool #

WebSearchTool(*, search_context_size=None, max_uses=None, user_location=None)

Bases: Tool

Source code in autogen/beta/tools/builtin/web_search.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def __init__(
    self,
    *,
    search_context_size: Literal["low", "medium", "high"] | Variable | None = None,
    max_uses: int | Variable | None = None,
    user_location: UserLocation | Variable | None = None,
) -> None:
    self._params: dict[str, object] = {}
    if search_context_size is not None:
        self._params["search_context_size"] = search_context_size
    if max_uses is not None:
        self._params["max_uses"] = max_uses
    if user_location is not None:
        self._params["user_location"] = user_location

schemas async #

schemas(context)
Source code in autogen/beta/tools/builtin/web_search.py 
52
53
54
async def schemas(self, context: "Context") -> list[WebSearchToolSchema]:
    resolved = {k: resolve_variable(v, context, param_name=k) for k, v in self._params.items()}
    return [WebSearchToolSchema(**resolved)]

register #

register(stack, context, *, middleware=())
Source code in autogen/beta/tools/builtin/web_search.py 
56
57
58
59
60
61
62
63
def register(
    self,
    stack: "ExitStack",
    context: "Context",
    *,
    middleware: Iterable["BaseMiddleware"] = (),
) -> None:
    pass