Felo API PlatformFelo API Platform
Tous les endpoints Tavily
v0.2.0-beta
OpenAPI 3.1.0

Tavily Search

Felo API Support
MIT
Serveur:https://openapi.felo.ai
Bibliothèques clientes
Shell Curl

Tavily Search

​

Recherche sur le web et renvoie des résultats classés avec titres, URL et extraits de contenu. query est obligatoire. Utilisez max_results pour contrôler le nombre de résultats et search_depth pour choisir le mode de recherche. Les champs answer, images et raw content supplémentaires ne sont renvoyés que sur demande. Définissez include_usage pour recevoir les informations d'utilisation des ressources ; usage.credits n'est pas un débit Felo.

Référence tarifaire

  • Mesure : unités de réponse mesurées.
  • Estimation de référence par requête : USD 0.016.
  • Base de coût unitaire : USD 0.008.
  • Unité de ressource : tavily_credit.
  • Multiplicateur client de référence : 1.0. Ne pas l'appliquer à nouveau à un montant client déjà réglé.
  • Les bases de coût ne déterminent pas le prix client final, y compris lorsqu'elles valent zéro.

Métadonnées de référence uniquement, et non un devis de compte, un prix garanti ou un plafond de dépenses. Les crédits de ressources ne sont pas des crédits Felo. Les débits définitifs suivent les enregistrements de facturation Felo.

Corps
obligatoire
application/json
  • query
    Type: string
    obligatoire

    Requête de recherche à exécuter avec Tavily.

  • auto_parameters
    Type: boolean

    Configure automatiquement les paramètres de recherche en fonction du contenu de la requête.

  • chunks_per_source
    Type: integer
    min.:  
    1
    max.:  
    3

    Nombre maximal de fragments pertinents renvoyés par source.

  • country
    Type: string enum

    Renforce les résultats de recherche d'un pays spécifique. Disponible uniquement lorsque topic vaut general.

    valeurs
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    Type: string Format: date

    Renvoyer les résultats antérieurs à la date de fin spécifiée.

  • exclude_domains
    Type: array string[] …150

    Liste des domaines à exclure spécifiquement des résultats de recherche.

  • include_answer

    Inclure une réponse générée par LLM. true utilise le mode de réponse par défaut ; basic ou advanced sélectionne le mode de génération de réponse.

    • Type: boolean

      Inclure une réponse générée par LLM. true utilise le mode de réponse par défaut ; basic ou advanced sélectionne le mode de génération de réponse.

  • include_domains
    Type: array string[] …300

    Liste des domaines à inclure spécifiquement dans les résultats de recherche.

  • include_favicon
    Type: boolean

    Inclure l'URL du favicon pour chaque résultat.

  • include_image_descriptions
    Type: boolean

    Ajouter un texte descriptif pour chaque image lorsque include_images est true.

  • include_images
    Type: boolean

    Effectuer une recherche d'images et inclure les résultats.

  • include_raw_content

    Inclure le contenu nettoyé et analysé pour chaque résultat de recherche. true ou markdown renvoie du markdown ; text renvoie du texte brut et peut augmenter la latence.

    • Type: boolean

      Inclure le contenu nettoyé et analysé pour chaque résultat de recherche. true ou markdown renvoie du markdown ; text renvoie du texte brut et peut augmenter la latence.

  • include_usage
    Type: boolean

    Inclure les informations d'utilisation des ressources dans la réponse. Il ne s'agit pas d'informations de facturation Felo.

  • max_results
    Type: integer
    min.:  
    0
    max.:  
    20

    Nombre maximal de résultats de recherche à renvoyer.

  • Type: boolean

    Filtrer le contenu pour adultes ou non sûr des résultats de recherche. Enterprise uniquement ; non pris en charge lorsque search_depth vaut fast ou ultra-fast.

  • search_depth
    Type: string enum

    Contrôle le compromis entre latence et pertinence. advanced offre la meilleure pertinence avec une latence et un coût plus élevés ; basic est équilibré ; fast et ultra-fast privilégient une latence plus faible.

    valeurs
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Type: string Format: date

    Renvoyer les résultats postérieurs à la date de début spécifiée.

  • time_range
    Type: string enum

    Plage temporelle pour filtrer les résultats selon la date de publication.

    valeurs
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Type: string enum

    Catégorie de la recherche.

    valeurs
    • general
    • news
    • finance
Réponses
  • 200
    Type: object

    Résultats de recherche renvoyés avec succès.

    • answer
      Type: string | null

      Réponse courte générée par LLM. Présente sous la forme null lorsque include_answer vaut false ou qu'aucune réponse n'est générée.

    • images
      Type: array object[]
      • description
        Type: string

        Description de l'image.

      • url
        Type: string

        URL de l'image.

    • query
      Type: string

      Requête de recherche qui a été exécutée.

    • request_id
      Type: string

      Identifiant unique de la requête.

    • response_time
      Type: number Format: float

      Temps en secondes nécessaire pour traiter la requête.

    • results
      Type: array object[]
      • content
        Type: string

        Extrait de contenu du résultat de recherche.

      • favicon
        Type: string | null

        URL du favicon du résultat de recherche.

      • raw_content
        Type: string | null

        Contenu source nettoyé et analysé. Null sauf si include_raw_content est demandé ou qu'aucun contenu brut n'est disponible.

      • score
        Type: number Format: float

        Score de pertinence du résultat de recherche.

      • title
        Type: string

        Titre du résultat de recherche.

      • url
        Type: string

        URL du résultat de recherche.

    • usage
      Type: object
      • credits
        Type: integer

        Unités de ressources consommées par cette requête, et non des USD ou des crédits Felo.

    application/json
  • 400

    La requête n'a pas pu être traitée. Vérifiez les paramètres de la requête.

  • 401

    Une clé API Felo valide est requise.

  • 402

    La requête ne peut pas aboutir car une condition de facturation n'est pas remplie.

  • 403

    Le compte n'est pas autorisé à effectuer cette opération.

  • 429

    Une limite de requêtes ou de dépenses a été atteinte.

  • 502

    Le service n'a pas pu terminer la requête.

  • 503

    L'API ou le service de facturation est temporairement indisponible.

  • 504

    Le service a expiré lors du traitement de la requête.

  • default

    Réponse d'erreur ; les réponses transmises depuis l'upstream peuvent utiliser les formats du fournisseur

    application/json
Request Example for post/v1/beta/tavily/search
curl --request POST https://openapi.felo.ai/v1/beta/tavily/search \
  --header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{"query": "Python official documentation", "search_depth": "basic", "max_results": 2, "include_usage": true}'

{
  "query": "Python official documentation",
  "answer": null,
  "images": [],
  "results": [
    {
      "title": "Python Documentation",
      "url": "https://docs.python.org/3/",
      "content": "Documentation for the Python programming language.",
      "score": 0.98,
      "raw_content": null
    }
  ],
  "response_time": 1.2,
  "usage": {
    "credits": 1
  },
  "request_id": "example-search-request"
}

Résultats de recherche renvoyés avec succès.

Tavily Search