Web Search

The retrieval.webSearch executes a web search using Tavily or the Bing Web Search.

Web Pages

By default, the API returns the first 10 web pages in the webPages field as an array of files, similarly to env.files. The content contains the summary snippet returned by the search engine.

const webPages = await retrieval.webSearch("microsoft")
def("PAGES", webPages)

You can use fetchText to download the full content of the web page.

Tavily Configuration

The Tavily API provides access to a powerfull search engine for LLM agents.

.env

TAVILY_API_KEY="your-api-key"

Bing Web Search configuration

The API uses Bing Web Search v7 to search the web. To use the API, you need to create a Bing Web Search resource in the Azure portal and store the API key in the .env file.

.env

BING_SEARCH_API_KEY="your-api-key"

Tool

Add the system.retrieval_web_search system script to register a tool that uses retrieval.webSearch.

script({
    ...,
    system: ["system.retrieval_web_search"]
})
...