Recherche avec Tavily AI

Introduction

Ce guide vous permettra de créer un bloc de recherche web dans Thinkeo.

Pour réaliser cette App nous utiliserons l’API de Tavily AI ainsi que le bloc Appel d’API.

Dans ce tutoriel, nous aborderons :

Comment récupérer une clé API sur Tavily AI
Les pré-requis pour l’App et un paramétrage d’exemple
Le paramétrage du bloc Appel d’API
Comment vérifier son Appel API

1. Récupérer une clé API sur Tavily AI

Rendez vous sur le site de Tavily AI et créez votre compte.

Depuis la page “Overwiew” vous accédez à vos clés API, il en existe une “default” disponible dès la création du compte. Vous pourrez utiliser cette clé, ou en créer une nouvelle du nom de votre choix, en cochant éventuellement “Limit monthly usage” et en précisant le nombre d’appels API autorisés pour cette clé API.

Pour cet exemple, nous utiliserons une clé nommée “Thinkeo” sans limite mensuelle.

2. Pré-requis pour une App de recherche

Un Attribut texte pour la clé API Tavily
Un Attribut texte pour le contenu envoyé à Tavily afin d’effectuer la recherche
Une App avec un bloc Appel API

Dans cet exemple, nous nommerons l’attribut pour la clé API Tavily “Clé API Tavily” et l’attribut pour le contenu de recherche “Recherche Tavily”.



Sur une App “Recherche Web” nous avons ajouté un bloc Appel d’API, que nous allons maintenant paramétrer.

3. Paramétrage du bloc Appel d’API

Pour paramétrer ce bloc, nous nous appuierons sur la documentation dédiée au bloc **Blocs Appel d'API** ainsi que sur la documentation API Rest de Tavily https://docs.tavily.com/docs/tavily-api/rest_api

Méthode : POST

URL : https://api.tavily.com/search

En-têtes :

{"content-type":"application/json"}

Pour le Corps, nous avons plusieurs approches, selon si vous souhaitez inscrire votre clé API Tavily en tant que valeur d’attribut dans l’éditeur d’attribut et dans le wizard, uniquement dans le wizard ou la placer par défaut dans le bloc d’Appel API (méthode recommandée).

Pour toutes les méthodes, “Id de l'attribut Clé API Tavily” et "Id de l'attribut Recherche Tavily" sont à remplacer par l’ID de votre attribut, accessible depuis l’éditeur d’attributs.



Vous pouvez cliquer sur l’icone à droite de l’ID pour le copier, puis le coller dans votre bloc Appel d’API.

Pour l’API Key

3 Méthodes sont possibles, je vous invite à suivre celle qui vous convient le mieux parmi les suivantes :
Méthode 1, avec une valeur associée dans l’éditeur d’attribut et le wizard
Méthode 2, avec une valeur associée dans le wizard uniquement
Méthode 3, avec une valeur spécifiée uniquement dans le bloc Appel d’API (recommandée)


Méthode 1, avec une valeur associée dans l’éditeur d’attribut et le wizard :

Corps :

{
      "api_key":"{{attributes["Id de l'attribut Clé API Tavily"] | escape_json }}",
      "search_depth": "advanced",
      "include_raw_content": true,
      "query":"{{attributes["Id de l'attribut Recherche Tavily"] | escape_json }}"
    }

Ajoutez votre clé API en tant que valeur d’attribut pour Clé API Tavily



Ensuite, ajoutez sur une Etape de votre Wizard l’assignation de cette valeur d’attribut.



Méthode 2, avec une valeur associée dans le wizard uniquement :

Corps :

{
      "api_key":"{{attributes["Id de l'attribut Clé API Tavily"] | escape_json }}",
      "search_depth": "advanced",
      "include_raw_content": true,
      "query":"{{attributes["Id de l'attribut Recherche Tavily"] | escape_json }}"
    }

Ici, aucune valeur d’attribut dans l’éditeur pour Clé API Tavily



Ensuite, ajoutez sur une Etape de votre Wizard l’assignation de cette valeur d’attribut en la saisissant manuellement





Méthode 3, avec une valeur spécifiée uniquement dans le bloc Appel d’API (recommandée) :

Corps :

{
      "api_key":"{{attributes["Id de l'attribut Clé API Tavily"]|default("votre clé API") | escape_json }}",
      "search_depth": "advanced",
      "include_raw_content": true,
      "query":"{{attributes["Id de l'attribut Recherche Tavily"] | escape_json }}"
    }

Ici, aucune valeur d’attribut dans l’éditeur pour Clé API Tavily



Et on va ajouter la clé API à côté de “default” directement dans le Corps. La formule “Default” permet de spécifier une valeur par défaut pour l’attribut concerné, donc dans notre cas, la clé API Tavily.

{
      "api_key":"{{attributes["Id de l'attribut Clé API Tavily"] | default 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 | escape_json }}",
      "search_depth": "advanced",
      "include_raw_content": true,
      "query":"{{attributes["Id de l'attribut Recherche Tavily"] | escape_json }}"
    }

Avec la méthode 3, on obtient donc le Corps suivant :

{
    "api_key":"{{attributes["01912d43-bfc2-77b2-8994-5dc36892d355"]|default("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") | escape_json }}",
    "search_depth": "advanced",
    "include_raw_content": true,
    "query":"{{attributes["01912cee-163b-7b41-9474-41e6274fa2c0"] | escape_json }}"
}

Vous l’aurez compris, la “Query” correspond à ce que nous allons demander à Tavily de rechercher, il convient donc d’associer cet attribut à une Étape “Champ de texte” de votre Wizard pour permettre à l’utilisateur de taper ce qu’il veut rechercher.

4. Pour vérifier son bloc Appel d’API

Placer le bloc au plus haut niveau dans l’App pour voir son contenu dans l’interface de publication.

Le contenu arrivera après execution du bloc, comme pour un bloc IA, et vous verrez soit la réponse de l’Appel API soit un message d’erreur.

Si vous recevez une erreur de type

{”détail”:”Method Not Allowed”} vérifiez la Méthode et l’URL de votre bloc Appel d’API

Si vous recevez une erreur de ce type :



Essayez de changer les attributs utilisés dans votre Appel API par des nouveaux, il est possible qu’un des attributs soit endommagé suite à la suppression de la dernière valeur qui lui était attribuée.

Pour toute autre erreur, consultez le message et vérifiez la syntaxe de votre Corps dans un éditeur de JSON pour vous aider à identifier les éventuelles erreurs.

Vous pouvez également revenir sur la documentation du bloc Appel API pour vérifier que tout est correct Blocs Appel d'API .

Mis à jour le : 03/02/2025