Interactions avec l'API

À chaque tour de conversation, une interaction a lieu. Lors d'une interaction, un utilisateur final envoie des données à l'assistant virtuel, qui lui envoie une réponse. Vous pouvez utiliser l'API Dialogflow pour interagir avec l'assistant lors de l'exécution.

Avant de commencer

Avant de lire ce guide, procédez comme suit :

  1. Créez un assistant virtuel ou continuez à utiliser l'assistant que vous avez créé dans la section Créer une application d'assistant virtuel.

Collecter les ID

Les exemples ci-dessous nécessitent plusieurs ID en entrée. Pour trouver l'ID de votre projet, de votre région et de votre application, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Search and Conversation.

    Recherche et conversation

  2. Votre ID de projet est affiché en haut de la console.

  3. La colonne Emplacement affiche les ID des régions.

  4. Sélectionnez une application.

  5. Le segment du chemin de l'URL du navigateur après agents/ contient l'ID de l'assistant.

Vous avez également besoin d'un ID de session. Une session représente une conversation entre un assistant virtuel et un utilisateur final. Vous créez un ID de session unique au début d'une conversation et vous l'utilisez pour chaque tour de conversation. Pour essayer l'API, vous pouvez utiliser un ID de chaîne de 36 octets maximum, tel que test-session-123.

Appeler la détection d'intent

Les exemples suivants appellent la méthode Sessions.detectIntent.

Sélectionnez un protocole et une version pour la référence de session :

Protocole V3 V3beta1
REST Ressource de la session Ressource de la session
RPC Interface de la session Interface de la session
C++ SessionsClient Non disponible
C# SessionsClient Non disponible
Go SessionsClient Non disponible
Java SessionsClient SessionsClient
Node.js SessionsClient SessionsClient
PHP Non disponible Non disponible
Python SessionsClient SessionsClient
Ruby Non disponible Non disponible

REST

Avant d'utiliser les données de requête, effectuez les remplacements suivants:

  • PROJECT_ID : ID de votre projet Google Cloud
  • ASSISTANT_ID: ID de votre assistant virtuel, qui correspond à l'ID de l'agent Dialogflow.
  • REGION_ID: identifiant de votre région
  • SESSION_ID : votre ID de session
  • END_USER_INPUT : entrée de l'utilisateur final (par exemple, "Je veux acheter une chemise")

Méthode HTTP et URL :

POST https://REGION_ID-dialogflow.googleapis.com/v3/projects/PROJECT_ID/locations/REGION_ID/agents/ASSISTANT_ID/sessions/SESSION_ID:detectIntent

Corps JSON de la requête :

{
  "queryInput": {
    "text": {
      "text": "END_USER_INPUT"
    },
    "languageCode": "en"
  },
  "queryParams": {
    "timeZone": "America/Los_Angeles"
  }
}

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir une réponse JSON de ce type :

{
  "responseId": "a6cd27b0-5eaa-4f93-aa6e-11faf97dbb63",
  "queryResult": {
    "text": "I want to buy a shirt",
    "languageCode": "en",
    "responseMessages": [
      {
        "text": {
          "text": [
            "Great! I can help you with that. We have a wide variety of shirts to choose from. What size and color would you like?"
          ]
        }
      }
    ],
    "intentDetectionConfidence": 1,
    "diagnosticInfo": {
      "Session Id": "123",
      "Response Id": "a6cd27b0-5eaa-4f93-aa6e-11faf97dbb63"
    },
    "match": {
      "confidence": 1
    },
    "advancedSettings": {
      "loggingSettings": {}
    }
  },
  "responseType": "FINAL"
}