Brave Search Tool

Brave Search Tool#

The Brave Search tool is a web search integration that enhances Squirro Chat agents by providing access to information from the web. This tool leverages the Retrieval Augmented Generation (RAG) principle to fetch relevant web content and generate informed answers, making it especially valuable for questions about recent events and topics that may not be covered in your indexed Squirro data.

Setup and Configuration#

Brave Search tool configuration

To use the Brave Search tool, you need:

  1. Brave Search API Account

    Sign up at Brave Search API.

  2. API Key

    Obtain your API key from the Brave Search API dashboard.

  3. Squirro Chat Agent

    Access to create or modify agents in your Squirro project. See the Configuring Agents and Tools page for guidance.

Adding the Tool to Your Agent#

  1. Navigate to Agent Configuration

    In your Squirro project, go to the agent configuration interface, where you can add tools to your chat agents.

  2. Add Brave Search Tool

    Select Brave Search from the available tools list.

  3. Configure the settings

    Customize the tool by adjusting the available parameters according to your requirements. See the Configuration Options section below for detailed information about each setting.

For more details on how to work with agents and tools, refer to the Configuring Agents and Tools page.

Configuration Options#

The Brave Search tool offers several settings you can adjust through the web interface.

  • Tool display name

    The display name is the user-friendly name that appears in the UI (for example, Web Research). That name is often more readable and accessible than the internal tool name, making it easier for users to understand and interact with the tool.

  • Tool name

    A concise and unique identifier used by the language model to reference this tool (for example, web_research). This name should be descriptive, yet brief, allowing for efficient identification and invocation of the tool.

  • Tool Description

    Provide a clear and concise description of the tool’s functionality and usage guidelines, enabling the language model to understand its purpose and apply it effectively (for example, Use this tool to search for current market information, competitor analysis, industry news, and regulatory updates not available in internal documents.)

  • API Key

    Enter your Brave Search API key obtained from your Brave Search API account. This key authenticates requests and enables access to web search functionality. Keep this key secure and do not share it with unauthorized users.

  • Country

    Choose a country code to prioritize results from specific regions (for example, US for teh United States, DE for Germany, FR for France).

  • Language

    Select the preferred language for search results (for example, en for English, de for German).

    • Result Count

    Set how many search results to return (20 by default). Higher numbers provide more comprehensive results but may slow response times.

  • Safesearch

    Choose content filtering level from the dropdown:

    • strict

      Filter out explicit content.

    • moderate

      Some filtering applied.

    • off

      No content filtering

  • Freshness

    Filter results by date using the text input field. Options include:

    • pd

      Past day (recent results from the last 24 hours).

    • pw

      Past week (results from the last 7 days).

    • pm

      Past month (results from the last 30 days).

    • py

      Past year (results from the last 12 months).

    • Date range

      Custom date range using the format YYYY-MM-DD..YYYY-MM-DD (for example, 2024-01-01..2024-03-31 for Q1 2024).

  • Text Decorations

    Enable rich text formatting (for example, bolding) in search result snippets using the checkbox.

  • Spellcheck

    Automatically correct spelling errors in search queries using the checkbox.

  • Result Filter

    Use the text input field to specify content types as a comma-separated list:

    • web

      Standard web content.

    • news

      News and journalism content.

    • discussions

      Forum and discussion content.

    • videos

      Video content results.

    • images

      Image search results.

    For example: web,news to include only web pages and news articles.

  • Goggles Id

    Enter the public ID of a Brave Search Goggle to focus on specific websites or topics.

  • Units

    Choose between metric or imperial units for results containing measurements using the dropdown (defaults to Reset which derives units from the search country).

Getting Assistance#

For assistance with Brave Search tool configuration or troubleshooting, contact Squirro Support and submit a technical support request. To learn more about Brave Search API capabilities and features, visit the official Brave Search API Documentation.


Contents