shopping_search()

Create a multi-marketplace product search tool.

Usage

shopping_search(
    *,
    provider="auto",
    allowed_engines=None,
    default_engine=None,
    include_examples=True,
    api_key=None,
    client=None,
    default_params=None,
    timeout=None,
    mode=SearchResultMode.COMPACT,
    response_format=SearchResultFormat.MARKDOWN,
    result_limit=60,
    name="shopping_search"
)

Parameters

provider: ProviderName | str = "auto": Agent SDK adapter name, "auto", or "function" for a callable.
allowed_engines: Iterable[ShoppingSearchEngine | str] | ShoppingSearchEngine | str | None = None: Marketplaces exposed in the model-facing engine enum.
default_engine: ShoppingSearchEngine | str | None = None: Marketplace used when the model omits engine.
include_examples: bool = True: Add a short call example to the model-facing description.
api_key: str | None = None: Runtime authentication, custom client, application filters, timeout, and response mode and serialization selection.
client: str | None = None: Runtime authentication, custom client, application filters, timeout, and response mode and serialization selection.
default_params: str | None = None: Runtime authentication, custom client, application filters, timeout, and response mode and serialization selection.
timeout: str | None = None: Runtime authentication, custom client, application filters, timeout, and response mode and serialization selection.
mode: str | None = None: Runtime authentication, custom client, application filters, timeout, and response mode and serialization selection.
response_format: str | None = None: Runtime authentication, custom client, application filters, timeout, and response mode and serialization selection.
result_limit: int | None = 60: Maximum items kept in each result list in both response modes; use None to keep all returned results.
name: str = "shopping_search": Tool name presented to the model.

Returns

Any: A provider-native tool whose input fields are query and engine.