ModelBox Open Source

/

AgentKit
Core Concepts/Tools/Built-in Tools/Brave Search Tool

Brave Search Tool

Privacy-focused web search using Brave Search API

|

The Brave Search tool provides privacy-focused web search functionality using the Brave Search API.

Installation

import "github.com/model-box/agent-kit/tool/brave_search"

Setup

Requirements

  1. Brave Search API Key: Sign up at Brave Search API
  2. API Access: Free tier includes 2,000 queries per month

Environment Variables

export BRAVE_SEARCH_API_KEY="your-brave-search-api-key"

Usage

package main

import (
    "context"
    "os"
    
    "github.com/model-box/agent-kit/agent"
    "github.com/model-box/agent-kit/model"
    "github.com/model-box/agent-kit/session"
    "github.com/model-box/agent-kit/tool/brave_search"
)

func main() {
    // Create Brave Search tools
    braveTools := brave_search.NewBraveSearchTools()
    
    // Create model
    model := model.Model("gpt-4o").
        SetAPIKey(os.Getenv("OPENAI_API_KEY"))
    
    // Create agent with Brave Search tool
    agent := agent.New().
        SetModel(model).
        SetSystemPrompt("You are a helpful assistant with web search capabilities.").
        AddTool(braveTools.WebSearch())
    
    // Create session and run
    session := session.New(agent)
    ctx := context.Background()
    
    response, err := session.Run(ctx, []agent.ChatMessage{
        agent.NewUserMessage("Search for the latest developments in quantum computing"),
    }, nil)
    
    if err != nil {
        panic(err)
    }
    
    println(response.GetLastMessage().GetContent())
}

Parameters

ParameterTypeRequiredDescription
querystringYesThe search query string
countintNoNumber of results (1-20, default: 10)
offsetintNoOffset for pagination (default: 0)
countrystringNoCountry code (e.g., "US", "GB", "FR")
languagestringNoLanguage code (e.g., "en", "fr", "de")
safesearchstringNo"off", "moderate", or "strict" (default: "moderate")
freshnessstringNoTime range: "pd" (day), "pw" (week), "pm" (month), "py" (year)

Features

  • Privacy-focused: No user tracking
  • Independent index: Not dependent on Google or Bing
  • Fresh results: Includes age indicators for recent content
  • Localization: Support for country and language-specific results
  • Safe search: Content filtering options

Rate Limits

  • Free tier: 2,000 queries/month
  • Basic tier: 20,000 queries/month
  • Professional tier: 100,000 queries/month
  • Enterprise: Custom limits

Country Codes

Common country codes:

  • US: United States
  • GB: United Kingdom
  • CA: Canada
  • AU: Australia
  • DE: Germany
  • FR: France
  • JP: Japan
  • IN: India

Language Codes

Common language codes:

  • en: English
  • es: Spanish
  • fr: French
  • de: German
  • it: Italian
  • pt: Portuguese
  • ru: Russian
  • zh: Chinese
  • ja: Japanese
Edit on GitHub