Où figurent les données d’utilisation d’une requête Brave Answers sans streaming ?

L'équipe Citead, mis à jour le

En bref. Les champs d’utilisation X-Request documentés se lisent dans les en-têtes de réponse lorsque Brave Answers renvoie une réponse sans streaming.

Définition : Pour une requête Brave Answers sans diffusion en continu (streaming), les métadonnées d’utilisation documentées par Brave figurent dans les en-têtes de la réponse HTTP. Les clés d’en-tête documentées indiquent les valeurs relatives aux requêtes API, aux recherches, aux jetons (tokens) et aux coûts de la réponse complète.

Points clés

  • Le guide du service Answers de Brave utilise stream=False dans son exemple de requête de base.
  • Le même guide précise qu’en streaming, les métadonnées d’utilisation figurent dans le dernier message et que, pour les requêtes synchrones, les clés sont incluses dans les en-têtes de réponse.
  • Les noms de métadonnées documentés comprennent X-Request-Requests, X-Request-Queries, X-Request-Tokens-In, X-Request-Tokens-Out et X-Request-Total-Cost.
  • La référence de l’API Answers de Brave documente POST /v1/chat/completions et fixe la valeur par défaut de stream à true.
  • Le guide de limitation du débit de Brave indique que chaque réponse de l’API inclut des en-têtes permettant de suivre les limites de débit.

Quelle requête produit une réponse synchrone ?

Le point de terminaison Answers est compatible avec OpenAI. Le guide du service de Brave indique ce point de terminaison :

https://api.search.brave.com/res/v1/chat/completions

Son exemple Python de base transmet stream=False. La référence de l’API décrit l’opération comme POST /v1/chat/completions. Puisque cette référence indique true comme valeur par défaut de stream, un client qui a besoin d’une réponse complète avant d’en lire le résultat doit définir explicitement ce paramètre à false.

L’exemple cURL du guide du service envoie également une requête JSON contenant "stream": false et utilise l’en-tête x-subscription-token pour l’authentification. La réponse se lit donc comme une réponse HTTP complète, avec ses en-têtes.

Quels en-têtes contiennent les valeurs d’utilisation ?

Le guide du service de Brave fournit cet exemple de métadonnées d’utilisation :

{
  "X-Request-Requests": 1,
  "X-Request-Queries": 2,
  "X-Request-Tokens-In": 1234,
  "X-Request-Tokens-Out": 300,
  "X-Request-Requests-Cost": 0,
  "X-Request-Queries-Cost": 0.008,
  "X-Request-Tokens-In-Cost": 0.00617,
  "X-Request-Tokens-Out-Cost": 0.0015,
  "X-Request-Total-Cost": 0.01567
}

Pour une requête synchrone, les valeurs X-Request-* se lisent dans les en-têtes de la réponse HTTP. Elles décrivent le nombre de requêtes API et de recherches, les jetons d’entrée et de sortie, ainsi que les coûts correspondants. La même documentation situe ces métadonnées dans le dernier message lorsque la requête utilise le streaming : les deux modes de réponse donnent donc accès à ces informations à des étapes différentes du traitement de la réponse.

Quel rapport entre les en-têtes de limites de débit et les en-têtes d’utilisation ?

Les en-têtes de limites de débit forment un groupe distinct. Le guide de limitation du débit de Brave nomme X-RateLimit-Limit, X-RateLimit-Policy, X-RateLimit-Remaining et X-RateLimit-Reset. Il décrit X-RateLimit-Remaining comme le quota restant dans chaque fenêtre de limitation et X-RateLimit-Reset comme le nombre de secondes avant la réinitialisation de ces fenêtres.

Le même guide indique que les limites de débit utilisent une fenêtre glissante de 1 seconde et qu’un dépassement renvoie le code HTTP 429. Un client peut donc examiner les deux groupes après une réponse synchrone : X-Request-* pour les métadonnées de ressources et de coûts de la réponse, et X-RateLimit-* pour l’état des quotas.

La référence de l’API inclut également un objet facultatif usage dans le schéma de réponse en cas de succès, avec completion_tokens, prompt_tokens et total_tokens. L’instruction du guide du service consacrée aux métadonnées d’utilisation en mode synchrone renvoie aux en-têtes de réponse : les noms d’en-tête ci-dessus désignent donc les champs documentés à recueillir pour la question traitée ici.

Termes associés

Questions fréquentes

Avec stream: false, les données d’utilisation figurent-elles dans le corps JSON ?

Le guide du service de Brave renvoie les clients synchrones aux en-têtes de réponse pour les métadonnées X-Request-* documentées. La référence de l’API inclut séparément un objet facultatif usage dans le schéma de réponse en cas de succès : les implémentations doivent donc conserver les en-têtes tout en vérifiant le comportement de leur client par rapport au schéma.

Quels en-têtes indiquent le quota restant ?

Lisez X-RateLimit-Remaining pour connaître le quota restant dans chaque fenêtre. Le guide de limitation du débit de Brave documente également X-RateLimit-Reset pour le délai avant la réinitialisation des fenêtres.

Sources

  1. Brave, « Answers », sans date
  2. Brave, « Answers API reference », sans date
  3. Brave, « Rate limiting », sans date

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

Testez une page et voyez quoi corriger en premier

L'analyse prend en général moins de 10 secondes et ne demande pas de compte.

400 000+ pages notées dans le benchmark public