Présentation de l'utilisation de l'API

Ce guide fournit une présentation de l'utilisation de l'API Dialogflow et de sa documentation de référence.

REST, gRPC et bibliothèques clientes

Vous pouvez accéder à l'API via REST, gRPC ou l'une des bibliothèques clientes fournies (basée sur gRPC).

Bibliothèques clientes

Google fournit des bibliothèques clientes pour de nombreux langages couramment utilisés pour accéder à cette API. Utilisez cette option si le langage de programmation que vous souhaitez utiliser est géré par les bibliothèques clientes.

Avantages Inconvénients
Géré par Google.
Authentification intégrée.
Nouvelles tentatives intégrées.
Idiomatique pour chaque langage.
Corps de requête HTTP avec tampon de protocole efficace.
Non disponible pour tous les langages de programmation.

REST

Cette API est compatible avec REST. Consultez la documentation de référence REST.

Avantages Inconvénients
Interface JSON simple.
Pleinement compatible avec de nombreux outils et bibliothèques Google et tiers
Vous devez créer votre propre client.
Vous devez mettre en œuvre l'authentification.
Vous devez mettre en œuvre les nouvelles tentatives.
Corps de requête HTTP JSON moins efficace.
Le streaming REST n'est pas compatible avec cette API.

gRPC

Cette API est compatible avec gRPC. Consultez la documentation de référence RPC qui fournit une description générique des types, des méthodes et des champs générés pour une bibliothèque gRPC.

Avantages Inconvénients
Compatible avec de nombreux langages de programmation.
Corps de requête HTTP avec tampon de protocole efficace.
Vous devez générer votre propre client à partir des tampons de protocole fournis par Google.
Vous devez mettre en œuvre l'authentification.
Vous devez mettre en œuvre les nouvelles tentatives.

Noms de type, de méthode et de champs

Selon que vous utilisez des bibliothèques clientes, REST ou gRPC, les noms de type, de méthode et de champ de l'API varient légèrement :

  • L'architecture REST est organisée par hiérarchies de ressources et leurs méthodes.
  • Les bibliothèques clientes et gRPC sont organisées par services et par leurs méthodes.
  • Les noms de champs REST utilisent la convention typographique camel case, mais le service d'API accepte aussi bien camel case que snake case.
  • Les noms de champs gRPC utilisent snake case.
  • Les noms de champs de la bibliothèque cliente utilisent soit la casse du titre, soit camel case ou snake case, selon le caractère idiomatique du nom dans le langage concerné.

Versions d'API

Les versions d'API suivantes sont disponibles :

  • V2 : stable, en disponibilité générale.
  • V2Beta1 : permet de partager les dernières fonctionnalités bêta à venir.