fc-plugin-codbi/com.github.xima_formcycle_entwicklerkreis.fc.plugin.codbi.logic.cb/BraveSearch

BraveSearch

BraveSearch — Web search via Brave Search API

Provides internet search capabilities for the AI model. When the model needs up-to-date information it can emit a CALL:search(query='...') marker. The servlet layer detects this, calls search, and feeds the results back into the conversation so the model can produce a grounded answer.

Configuration

Property	Format	Example
`AI_BraveSearch_ApiKey`	API key string	`BSA...xyz`
`AI_BraveSearch_MaxResults`	Integer (1–20)	`5`

API docs: https://api.search.brave.com/app/documentation/web-search

Domains to whitelist

api.search.brave.com — Brave Search API endpoint

Types

SearchResult

data class SearchResult(val title: String, val url: String, val description: String, val extraSnippets: List<String> = emptyList())

A single web search result.

Properties

apiKey

@Volatile

var apiKey: String?

The API key — set during plugin initialisation.

CALL_SEARCH_PATTERN

val CALL_SEARCH_PATTERN: Regex

Matches CALL:search(query='...'), CALL:search(query="..."), or positional CALL:search('...') / CALL:search("...") in model output.

filterResults

@Volatile

var filterResults: Boolean

Whether to filter sensitive data from queries (default: false, set by plugin property).

isAvailable

val isAvailable: Boolean

Whether web search is available (API key configured).

maxResults

@Volatile

var maxResults: Int

Maximum number of results to return (configurable via AI_BraveSearch_MaxResults).

Functions

formatResultsForModel

fun formatResultsForModel(results: List<BraveSearch.SearchResult>): String

Formats search results into a text block suitable for injecting into a conversation.

sanitizeQuery

fun sanitizeQuery(raw: String, language: String? = null, filterOverride: Boolean? = null): String

Sanitizes a search query by removing personally identifiable information (PII) and identifiers that should not be forwarded to an external search engine. Serves as a second layer of defense in addition to possible instructions in the prompt to the model to avoid including sensitive information in the query.

fun search(query: String, country: String? = null, language: String? = null, filterOverride: Boolean? = null): List<BraveSearch.SearchResult>

Searches the web using the Brave Search API.