Skip to main content

Filtering by Domain

You can filter web search results by specific domains when using either the Tavily or Google Search retrievers. This functionality is available across all interfaces - pip package, NextJS frontend, and vanilla JS frontend.

Note: We welcome contributions to add domain filtering to other retrievers!

To set Tavily as a retriever, you'll need to set the RETRIEVER environment variable to tavily and set the TAVILY_API_KEY environment variable to your Tavily API key.

RETRIEVER=tavily
TAVILY_API_KEY=your_tavily_api_key

To set Google as a retriever, you'll need to set the RETRIEVER environment variable to google and set the GOOGLE_API_KEY and GOOGLE_CX_KEY environment variables to your Google API key and Google Custom Search Engine ID.

RETRIEVER=google
GOOGLE_API_KEY=your_google_api_key
GOOGLE_CX_KEY=your_google_custom_search_engine_id

Using the Pip Package

When using the pip package, you can pass a list of domains to filter results:

report = GPTResearcher(
    query="Latest AI Startups",
    report_type="research_report",
    report_source="web",
    domains=["forbes.com", "techcrunch.com"]
)

Using the NextJS Frontend

When using the NextJS frontend, you can pass a list of domains to filter results via the Settings Modal:

Settings Modal

Using the Vanilla JS Frontend

When using the Vanilla JS frontend, you can pass a list of domains to filter results via the relevant input field:

Filter by Domain