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

BraveSearch

BraveSearch – Websuche über die Brave Search API

Bietet Internetsuchfunktionen für das KI-Modell. Wenn das Modell auf den neuesten Stand gebracht werden muss Informationen kann es einen „CALL:search(query='...')“-Marker ausgeben. Die Servlet-Schicht erkennt dies, ruft search auf und gibt die Ergebnisse zurück in die Konversation, damit das Modell eine erstellen kann fundierte Antwort.

Konfiguration

Eigentum	Formatieren	Beispiel
`AI_BraveSearch_ApiKey`	API-Schlüsselzeichenfolge	`BSA...xyz`
`AI_BraveSearch_MaxResults`	Ganzzahl (1–20)	`5`

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

Domains zur Whitelist

api.search.brave.com – Brave Search API-Endpunkt

Types

SearchResult

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

Ein einzelnes Websuchergebnis.

Properties

apiKey

@Volatile

var apiKey: String?

The API key — set during plugin initialisation.

CALL_SEARCH_PATTERN

val CALL_SEARCH_PATTERN: Regex

Entspricht CALL:search(query='...'), CALL:search(query="...") oder positional CALL:search('...') / CALL:search("...") in der Modellausgabe.

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

Formatiert Suchergebnisse in einen Textblock, der zum Einfügen in eine Konversation geeignet ist.

sanitizeQuery

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

Bereinigt eine Suchanfrage, indem personenbezogene Daten (PII) und Identifikatoren entfernt werden Das sollte nicht an eine externe Suchmaschine weitergeleitet werden. Dient als zweite Verteidigungsschicht Zusätzlich zu möglichen Anweisungen in der Eingabeaufforderung zum Modell, um sensible Einbeziehungen zu vermeiden Informationen in der Abfrage.

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

Durchsucht das Web mithilfe der Brave Search API.