如何让会话实体作为 Dialogflow 检测意图的一部分工作答案

【问题标题】：How to get Session Entities to work as part of Dialogflow detect intent如何让会话实体作为 Dialogflow 检测意图的一部分工作
【发布时间】：2019-10-05 20:10:00
【问题描述】：

我有一个实体，它应该在每个会话的基础上使用特定于用户的信息进行更新。这在我使用 Dialogflow v1 时有效，我认为它适用于 v2，但我现在遇到了严重的问题。

我相信我正确设置了会话实体信息，但对于使用它的 Intent，它仅在使用来自开发者实体的值时匹配。

我怎样才能让它使用会话实体？更新时我做错了吗？我是否使用了错误的会话 ID？有没有一种方法可以更好地验证或测试我使用的是正确的 ID 还是正确地更新了实体？这只是一个错误吗？

所有内容的文档如下。

该项目配置为使用 v2 并允许使用 beta 功能，尽管我也尝试过不使用 beta 功能。

只有三个意图。捕获失败的回退意图，获取欢迎事件的欢迎意图，以及应该捕获应该与“代码”实体匹配的入口代码的“入口”意图。他们都使用 webhook 来实现。

后备意图

欢迎意图

“入口”意图

如“entry”Intent所示，它使用“code”Entity，这是系统中唯一的Developer Entity

代码在一个单独的模块中包含大部分 Dialogflow 特定工作，该模块使用"dialogflow" module from npm 设置会话实体。（请注意，这与用于处理履行的 dialogflow-fulfillment 模块不同。我正在使用多声库来履行，但这不重要。）（它也使用 firebase 函数来运行，但我不'认为这些都不相关。）

来自 package.json：

  "dependencies": {
    "dialogflow": "^0.9.0",
    "firebase-admin": "~7.0.0",
    "firebase-functions": "^2.2.0",
    "multivocal": "^0.11.1"
  },

这是作为dialogflow 导入的，指定要使用的 API 版本：

const dialogflow = require('dialogflow').v2beta1;

我在下面显示的函数调用envToConfig(env)，它获取环境（一个只存储相关信息的多声道概念，包括对话流parent 和证书信息）并返回需要传递给dialogflow.SessionEntityTypesClient( config ) 的配置。鉴于在进一步调用中没有引发错误，它似乎可以正常工作。

makeEntityType( name, entityMap ) 函数获取用于SessionEntityType 中entities 的值映射，并返回将用于构建完整SessionEntityType 的对象。此处提供的name 是显示名称。

function makeEntityType( name, entityMap ){
  let ret = {
    displayName: name,
    entities: []
  };

  Object.keys( entityMap ).map( key => {
    let val = entityMap[key];
    let entity = {
      value: key,
      synonyms: [key, ...val]
    };
    ret.entities.push( entity );
  });

  return ret;
}
exports.makeEntityType = makeEntityType;

结果与多声环境一起传递给setSessionEntity( env, entityType )，其中包含我们在会话中使用的一些信息。它确保name 和entityOverrideMode 在entityType 中设置正确，然后尝试创建它。我也尝试过使用 PATCH，它的行为方式相同。它还进行了大量的日志记录，稍后我会在它运行时展示它以证明它确实有效。

function setSessionEntity( env, entityType ){
  const config = envToConfig( env );
  const client = new dialogflow.SessionEntityTypesClient( config );

  let parent = env.dialogflow.parent;
  if( entityType.displayName && !entityType.name ){
    entityType.name = `${parent}/entityTypes/${entityType.displayName}`;
  }
  if( !entityType.entityOverrideMode ){
    entityType.entityOverrideMode = 'ENTITY_OVERRIDE_MODE_OVERRIDE';
  }

  console.log('setSessionEntity parent',parent);
  const request = {
    parent: parent,
    sessionEntityType: entityType
  };
  console.log('setSessionEntity request',JSON.stringify(request,null,1));
  return client.createSessionEntityType( request )
    .then( create => {
      console.log('setSessionEntity created',JSON.stringify(create,null,1));
      return Promise.resolve( env );
    })
    .catch( err => {
      console.error('setSessionEntity problem creating',err);
      return Promise.resolve( env );
    })
}
exports.setSessionEntity = setSessionEntity;

为了调试，我还有一个列出会话实体的函数：

function listSessionEntities( env ){
  let parent = env.dialogflow && env.dialogflow.parent;
  console.log('listSessionEntities parent', parent);
  if( !parent ){
    return Promise.resolve( env );
  }

  const config = envToConfig( env );
  const client = new dialogflow.SessionEntityTypesClient( config );
  const request = {
    parent: parent
  };
  return client.listSessionEntityTypes(request)
    .then( result => {
      console.log('listSessionEntities', JSON.stringify(result,null,1));
    })
    .catch( err => {
      console.log('listSessionEntities err', err);
    })
    .then( () => Promise.resolve( env ) );
}
exports.listSessionEntities = listSessionEntities;

调用它的代码将其导入为Dialogflow：

const Dialogflow = require('./dialogflow');

作为所有 webhook 调用的一部分，listSessionEntities() 函数在任何特定处理程序之前被调用：

function debugSessionEntities( env ){
  return Dialogflow.listSessionEntities( env );
}

当 Welcome Intent 被触发时，它将“代码”会话实体设置为具有两个新类型，这些类型应该覆盖“代码”开发者实体中定义的类型：

function handleWelcome( env ){
  const entityType = Dialogflow.makeEntityType('code',{
    'alpha': [],
    'bravo': []
  });
  return Dialogflow.setSessionEntity( env, entityType )
    .then( env => Multivocal.handleDefault( env ) );
}

当我通过模拟器运行它时，它不会选择设置的会话实体类型，但仍会响应开发者实体类型。（使用真实设备也是如此。）

在模拟器中，这是它在欢迎意图的“请求”选项卡中报告的内容：

{
  "responseId": "55a9eb06-ce05-48f9-8a56-b993fa512aee",
  "queryResult": {
    "queryText": "GOOGLE_ASSISTANT_WELCOME",
    "action": "multivocal.welcome",
    "parameters": {},
    "allRequiredParamsPresent": true,
    "fulfillmentText": "Hello! How can I help you?",
    "fulfillmentMessages": [
      {
        "text": {
          "text": [
            "Greetings! How can I assist?"
          ]
        }
      }
    ],
    "outputContexts": [
      {
        "name": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX/contexts/google_assistant_welcome"
      },
      {
        "name": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX/contexts/actions_capability_screen_output"
      },
      {
        "name": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX/contexts/actions_capability_audio_output"
      },
      {
        "name": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX/contexts/actions_capability_account_linking"
      },
      {
        "name": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX/contexts/google_assistant_input_type_keyboard"
      },
      {
        "name": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX/contexts/actions_capability_media_response_audio"
      },
      {
        "name": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX/contexts/actions_capability_web_browser"
      }
    ],
    "intent": {
      "name": "projects/session-test-XXXXX/agent/intents/ca79c951-4d75-4b2b-acd4-7dac2f81856e",
      "displayName": "welcome"
    },
    "intentDetectionConfidence": 1,
    "languageCode": "en-us"
  },
  "originalDetectIntentRequest": {
    "source": "google",
    "version": "2",
    "payload": {
      "isInSandbox": true,
      "surface": {
        "capabilities": [
          {
            "name": "actions.capability.SCREEN_OUTPUT"
          },
          {
            "name": "actions.capability.ACCOUNT_LINKING"
          },
          {
            "name": "actions.capability.AUDIO_OUTPUT"
          },
          {
            "name": "actions.capability.MEDIA_RESPONSE_AUDIO"
          },
          {
            "name": "actions.capability.WEB_BROWSER"
          }
        ]
      },
      "requestType": "SIMULATOR",
      "inputs": [
        {
          "rawInputs": [
            {
              "query": "Talk to my test app",
              "inputType": "KEYBOARD"
            }
          ],
          "intent": "actions.intent.MAIN"
        }
      ],
      "user": {
        "userStorage": "{\"UserId\":\"ABwppHHd40lIZ1o0bRERAKlHNtNcS2qFtz7NbRQnb31AQDFuV41VPFQivXwwpQGtv_5SlsZNp0N3kxalIIXXXXXX\",\"NumVisits\":1}",
        "lastSeen": "2019-05-18T19:12:38Z",
        "locale": "en-US",
        "userId": "ABwppHHd40lIZ1o0bRERAKlHNtNcS2qFtz7NbRQnb31AQDFuV41VPFQivXwwpQGtv_5SlsZNp0N3kxalIIXXXXXX"
      },
      "conversation": {
        "conversationId": "ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX",
        "type": "NEW"
      },
      "availableSurfaces": [
        {
          "capabilities": [
            {
              "name": "actions.capability.AUDIO_OUTPUT"
            },
            {
              "name": "actions.capability.WEB_BROWSER"
            },
            {
              "name": "actions.capability.SCREEN_OUTPUT"
            }
          ]
        }
      ]
    }
  },
  "session": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX"
}

最值得注意的是底部设置的session 属性。代码在构建

时将其用作 parent 和 session 值

其他两个 Intent 的请求对象是相似的，并且都具有相同的 session 值。没有任何响应对象是值得注意的。

当 Welcome Intent 被触发时，对 listSessionEntities() 的调用会毫不奇怪地显示还没有：

info: listSessionEntities parent projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX
info: listSessionEntities [
 [],
 null,
 null
]

但是，parent 似乎具有来自 session 的正确值。

当 Welcome Intent 的处理程序创建会话实体时，一切正常：

info: setSessionEntity request {
 "parent": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX",
 "sessionEntityType": {
  "displayName": "code",
  "entities": [
   {
    "value": "alpha",
    "synonyms": [
     "alpha"
    ]
   },
   {
    "value": "bravo",
    "synonyms": [
     "bravo"
    ]
   }
  ],
  "name": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX/entityTypes/code",
  "entityOverrideMode": "ENTITY_OVERRIDE_MODE_OVERRIDE"
 }
}
info: setSessionEntity created [
 {
  "entities": [
   {
    "synonyms": [
     "alpha"
    ],
    "value": "alpha"
   },
   {
    "synonyms": [
     "bravo"
    ],
    "value": "bravo"
   }
  ],
  "name": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX/entityTypes/code",
  "entityOverrideMode": "ENTITY_OVERRIDE_MODE_OVERRIDE"
 },
 null,
 null
]

parent 似乎与session 相同，name 似乎遵循正确的格式，包括具有“/entityTypes/”后跟显示名称的附加部分。

当我尝试使用代码“alpha”调用它时，它应该会触发“entry” Intent，但它会触发 Fallback Intent。对listSessionEntities() 的调用似乎显示了具有我们期望的实体类型的“代码”实体，即使没有匹配“alpha”。

info: listSessionEntities parent projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX
info: listSessionEntities [
 [
  {
   "entities": [
    {
     "synonyms": [
      "alpha"
     ],
     "value": "alpha"
    },
    {
     "synonyms": [
      "bravo"
     ],
     "value": "bravo"
    }
   ],
   "name": "projects/session-test-XXXXX/agent/sessions/ABwppHFGTpcFtHOOo6ehQfKys9AnH14V5-RhzrNKsea6y6L5zgv4eN-j3IesfuqSsKMc7qRt1CAOhkUYA9XXXXXX/entityTypes/code",
   "entityOverrideMode": "ENTITY_OVERRIDE_MODE_OVERRIDE"
  }
 ],
 null,
 null
]

再次，一切看起来都是正确的。当我用“zulu”再次尝试时，它对listSessionEntites() 的调用显示相同的内容，但这次它与“entry” Intent 匹配，因为“zulu”是“code”的实体类型之一，即定义为开发者实体。

这就是我卡住的地方。一切看起来都是正确的。看起来应该为此会话正确设置会话实体。看起来它应该使用这些值。但它似乎从来没有这样做过。

发生了什么事？非常感谢所有帮助。（你有没有读到问题的最后？如果有，谢谢！我知道它很长，但希望尽可能完整。）

【问题讨论】：

标签： node.js google-cloud-platform dialogflow-es actions-on-google

【解决方案1】：

这似乎是一个错误 - 我从其他开发人员那里得到反馈，他们遇到了同样的问题，有时是在以前工作的代码上。

已在https://issuetracker.google.com/issues/133166381 上打开一个错误以跟踪问题。给它加星标表示您有类似的问题并跟踪进度。

【讨论】：