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

BraveSearch

BraveSearch: ricerca sul Web tramite Brave Search API

Fornisce funzionalità di ricerca su Internet per il modello AI. Quando il modello deve essere aggiornato informazioni può emettere un marcatore CALL:search(query='...'). Il livello servlet lo rileva, chiama search e reinserisce i risultati nella conversazione in modo che il modello possa produrre a risposta fondata.

##Configurazione | Immobile | Formato | Esempio | |-----------------------|----------------|-------------| | "AI_BraveSearch_ApiKey" | Stringa chiave API | BSA...xyz | | "AI_BraveSearch_MaxResults" | Intero (1–20) | "5" |

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

Domini da autorizzare

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

Types

SearchResult

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

Un singolo risultato di ricerca web.

Properties

apiKey

@Volatile

var apiKey: String?

The API key — set during plugin initialisation.

CALL_SEARCH_PATTERN

val CALL_SEARCH_PATTERN: Regex

Corrisponde a CALL:search(query='...'), CALL:search(query="...") o posizionale CALL:search('...') / CALL:search("...") nell'output del modello.

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

Formatta i risultati della ricerca in un blocco di testo adatto per essere inserito in una conversazione.

sanitizeQuery

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

Disinfetta una query di ricerca rimuovendo le informazioni di identificazione personale (PII) e gli identificatori che non devono essere inoltrati a un motore di ricerca esterno. Serve come secondo livello di difesa oltre alle possibili istruzioni nel prompt al modello per evitare di includere dati sensibili informazioni nella query.

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

Effettua ricerche sul Web utilizzando l'API Brave Search.