Comment supprimer les marqueurs de surbrillance des extraits de l’API Brave ?

Définition : Le paramètre text_decorations de l’API Brave Search détermine si les chaînes de caractères destinées à l’affichage, dont les extraits de résultats (snippets), contiennent des marqueurs de mise en forme, tels que des caractères de surbrillance. Définir ce paramètre booléen sur false dans la requête permet de demander des extraits sans ces marqueurs.

Points clés

• La référence Web Search GET de Brave présente text_decorations comme un paramètre de requête booléen dont la valeur par défaut est true.
• Cette référence indique que le réglage s’applique aux chaînes destinées à l’affichage, en donnant les extraits de résultats comme exemple, et cite les caractères de surbrillance comme exemple de marqueurs de mise en forme.
• La référence GET place ce réglage parmi les autres paramètres de requête de Web Search : il figure donc dans l’URL d’une requête de recherche GET.
• La référence Web Search POST de Brave présente la même propriété comme un champ booléen du corps de la requête, avec la même valeur par défaut.

Comment ajouter ce réglage à une requête GET ?

La référence GET indique que le chemin de Web Search est /v1/web/search et donne https://api.search.brave.com/res comme URL de base. Le paramètre documenté peut donc être ajouté à la chaîne de requête avec la valeur false :

GET /res/v1/web/search?q=brave+search&text_decorations=false

Le nom du paramètre contient un tiret bas : text_decorations. Sa valeur est un booléen : false permet de demander des chaînes destinées à l’affichage sans les marqueurs de mise en forme décrits par Brave. La référence donne true comme valeur par défaut : une requête qui omet ce paramètre utilise donc le comportement par défaut documenté.

Comment ajouter ce réglage à une requête POST ?

La référence POST présente Web Search sous la forme d’une requête JSON dont les propriétés comprennent text_decorations. La propriété correspondante dans le corps de la requête s’écrit ainsi :

{
  "q": "brave search",
  "text_decorations": false
}

La documentation POST indique également le type boolean pour cette propriété et la décrit avec la même phrase que la référence GET. Un client qui utilise POST peut placer le booléen dans le corps de la requête au lieu de l’ajouter à la chaîne de requête de l’URL.

Que change la valeur false ?

Brave définit le périmètre du réglage comme étant les chaînes destinées à l’affichage. L’exemple donné porte sur les extraits de résultats, et la description associe ce réglage aux marqueurs de mise en forme, dont les caractères de surbrillance. Le réglage concerne donc le texte renvoyé dans ces chaînes. Il contrôle le format de la réponse à la requête API. Il ne se configure pas sur le site web source.

Les références de Brave ne précisent ni les caractères exacts utilisés comme marqueurs ni une syntaxe distincte permettant de les supprimer après réception de la réponse. Si une intégration reçoit déjà du texte avec ces marqueurs, définir text_decorations=false dans la requête suivante est le réglage documenté à utiliser.

Termes associés

• Brave Search API
• Le paramètre offset de Brave compte-t-il les résultats ou les pages de résultats ?
• Le paramètre count de Brave limite-t-il aussi les résultats d’actualité et de recherche de lieux ?

Questions fréquentes

Peut-on définir text_decorations sur false dans une requête GET ?

Oui. Ajoutez text_decorations=false à la chaîne de requête de Web Search. La référence GET définit ce paramètre comme un booléen et indique true comme valeur par défaut.

Peut-on utiliser le même réglage avec POST ?

Oui. Ajoutez "text_decorations": false au corps JSON de la requête. La référence POST de Brave documente cette propriété avec la même description et la même valeur par défaut que la référence GET.

Sources

1. Brave Search API, « Web Search API reference, GET », sans date
2. Brave Search API, « Web Search API reference, POST », sans date

---

Vérifiez comment une page se lit pour les moteurs de réponse. Ouvrir l’analyseur de score GEO