Агенты Business Messages поддерживают прямую интеграцию с
- Dialogflow ES: боты для сопоставления намерений и часто задаваемые вопросы
- Dialogflow CX: сопоставление намерений и передача управления активным агентом
Чтобы интегрировать агента Business Messages с другими функциями Dialogflow ES или Dialogflow CX , обратитесь к документации каждого продукта.
Когда пользователь отправляет сообщение агенту, имеющему интеграцию с Dialogflow, Business Messages передает сообщение пользователя в Dialogflow и отправляет ответ Dialogflow агенту в объекте сообщения dialogflowResponse . Вы можете настроить агентов на автоматическую отправку ответа Dialogflow пользователю без каких-либо действий с вашей стороны. Подробности см. в разделе «Автоответы» .
Интеграция с диалоговым потоком
Прежде чем вы сможете использовать автоматизацию на основе Dialogflow через Business Messages, вам необходимо включить интеграцию Dialogflow.
Предварительные условия
Для начала вам нужно
- агент бизнес-сообщений
- агент Dialogflow в глобальном регионе с корневым языком английский (en)
Если у вас нет агента Dialogflow, создайте его .
Диалоговый поток ES
Прежде чем вы сможете включить интеграцию Dialogflow ES, вам понадобится идентификатор проекта вашего агента Dialogflow. Чтобы найти идентификатор проекта,
- Перейдите в консоль Dialogflow .
- Выберите агент Dialogflow, которого вы хотите подключить к Business Messages, затем щелкните значок шестеренки.
рядом с именем агента. - В разделе «Проект Google» обратите внимание на значение идентификатора проекта .
Диалоговый поток CX
Прежде чем вы сможете включить интеграцию Dialogflow CX, вам понадобится идентификатор проекта и идентификатор агента вашего агента Dialogflow. Чтобы найти эти идентификаторы,
- Перейдите в консоль Dialogflow CX .
- Выберите проект Dialogflow.
- В средстве выбора агента щелкните дополнительное меню.
рядом с вашим агентом Dialogflow. - Нажмите «Копировать имя» . При этом полное имя вашего агента копируется в следующем формате:
projects/PROJECT_ID/locations/REGION_ID/agents/AGENT_ID. - Обратите внимание на значения идентификатора проекта и идентификатора агента.
Создайте интеграцию
Получите адрес электронной почты учетной записи службы Dialogflow партнера из
dialogflowServiceAccountEmail. Замените PARTNER_ID на идентификатор вашего партнера.КУЛЬ
# This code gets the partner. # Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/partners/get # Replace the __PARTNER_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X GET \ "https://businesscommunications.googleapis.com/v1/partners/__PARTNER_ID__" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)"
Node.js
/** * This code snippet gets a partner. * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/partners/get * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const PARTNER_ID = 'EDIT_HERE'; const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json'; const businesscommunications = require('businesscommunications'); const {google} = require('googleapis'); // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ 'https://www.googleapis.com/auth/businesscommunications', ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); const partnerName = 'partners/' + PARTNER_ID; if (authClient) { // Setup the parameters for the API call const apiParams = { auth: authClient, name: partnerName, }; bcApi.partners.get(apiParams, {}, (err, response) => { if (err !== undefined && err !== null) { console.dir(err); } else { // Agent found console.log(response.data); } }); } else { console.log('Authentication failure.'); } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();
Питон
"""This code gets a partner. Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/partners/get This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( Agent, BusinesscommunicationsPartnersGetRequest, ) # Edit the values below: PARTNER_ID = 'EDIT_HERE' SCOPES = ['https://www.googleapis.com/auth/businesscommunications'] SERVICE_ACCOUNT_FILE = './service_account_key.json' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) partners_service = BusinesscommunicationsV1.PartnersService(client) partner_name = 'partners/' + PARTNER_ID partner = partners_service.Get(BusinesscommunicationsPartnersGetRequest( name=partner_name )) print(partner)
Скопируйте адрес электронной почты сервисного аккаунта. Эта учетная запись соединяет ваши бизнес-сообщения и агенты Dialogflow.
В Google Cloud Console выберите проект Dialogflow.
Перейдите к разрешениям IAM .
Нажмите «Добавить» и введите адрес электронной почты учетной записи службы для новых участников .
В поле «Выберите роль» выберите «Редактор агента консоли Dialogflow» .
Нажмите «Добавить другую роль» и выберите «Клиент Dialogflow API» .
Нажмите Сохранить .
Интегрируйте свой проект Dialogflow с агентом Business Messages.
Замените AUTO_RESPONSE_STATUS на ENABLED или DISABLED, в зависимости от того, хотите ли вы, чтобы Business Messages автоматически отвечала пользователям с помощью ответов Dialogflow.
Диалоговый поток ES
КУЛЬ
# This code creates a Dialogflow ES integration. # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#dialogflow_es # Replace the __BRAND_ID__, __AGENT_ID__, __DIALOGFLOW_ES_PROJECT_ID__ and __AUTO_RESPONSE_STATUS__ # Make sure a service account key file exists at ./service_account_key.json curl -X POST \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/integrations" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -d '{ "dialogflowEsIntegration": { "dialogflowProjectId": "__DIALOGFLOW_ES_PROJECT_ID__", "autoResponseStatus": "__AUTO_RESPONSE_STATUS__" } }'
Node.js
/** * This code snippet creates a Dialogflow ES integration. * Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#dialogflow_es * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const BRAND_ID = 'EDIT_HERE'; const AGENT_ID = 'EDIT_HERE'; const DIALOGFLOW_ES_PROJECT_ID = 'EDIT_HERE' const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json'; const businesscommunications = require('businesscommunications'); const {google} = require('googleapis'); const uuidv4 = require('uuid').v4; // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ 'https://www.googleapis.com/auth/businesscommunications', ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); const agentName = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID; if (authClient) { const integrationObject = { dialogflowEsIntegration: { dialogflowProjectId: DIALOGFLOW_ES_PROJECT_ID, autoResponseStatus: 'ENABLED' } }; // Setup the parameters for the API call const apiParams = { auth: authClient, parent: agentName, resource: integrationObject }; bcApi.brands.agents.integrations.create(apiParams, {}, (err, response) => { if (err !== undefined && err !== null) { console.dir(err); } else { // Agent created console.log(response.data); } }); } else { console.log('Authentication failure.'); } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();
Питон
"""This code snippet creates a Dialogflow ES integration. Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#dialogflow_es This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( BusinesscommunicationsBrandsAgentsIntegrationsCreateRequest, DialogflowEsIntegration ) # Edit the values below: BRAND_ID = 'EDIT_HERE' AGENT_ID = 'EDIT_HERE' DIALOGFLOW_ES_PROJECT_ID = 'EDIT_HERE' SCOPES = ['https://www.googleapis.com/auth/businesscommunications'] SERVICE_ACCOUNT_FILE = './service_account_key.json' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) integrations_service = BusinesscommunicationsV1.BrandsAgentsIntegrationsService(client) agent_name = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID integration = integrations_service.Create(BusinesscommunicationsBrandsAgentsIntegrationsCreateRequest( integration=DialogflowEsIntegration( autoResponseStatus=DialogflowEsIntegration.AutoResponseStatusValueValuesEnum.ENABLED, dialogflowProjectId=DIALOGFLOW_ES_PROJECT_ID ), parent=agent_name )) print(integration)
Диалоговый поток CX
КУЛЬ
# This code creates a Dialogflow CX integration. # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#dialogflow_cx # Replace the __BRAND_ID__, __AGENT_ID__, __DIALOGFLOW_CX_PROJECT_ID__, __DIALOGFLOW_CX_AGENT_ID__ and __AUTO_RESPONSE_STATUS__ # Make sure a service account key file exists at ./service_account_key.json curl -X POST \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/integrations" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -d '{ "dialogflowCxIntegration": { "dialogflowProjectId": "__DIALOGFLOW_CX_PROJECT_ID__", "dialogflowAgentId": "__DIALOGFLOW_CX_AGENT_ID__", "autoResponseStatus": "__AUTO_RESPONSE_STATUS__" } }'
Node.js
/** * This code snippet creates a Dialogflow CX integration. * Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#dialogflow_cx * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const BRAND_ID = 'EDIT_HERE'; const AGENT_ID = 'EDIT_HERE'; const DIALOGFLOW_CX_AGENT_ID = 'EDIT_HERE' const DIALOGFLOW_CX_PROJECT_ID = 'EDIT_HERE' const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json'; const businesscommunications = require('businesscommunications'); const {google} = require('googleapis'); const uuidv4 = require('uuid').v4; // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ 'https://www.googleapis.com/auth/businesscommunications', ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); const agentName = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID; if (authClient) { const integrationObject = { dialogflowCxIntegration: { dialogflowProjectId: DIALOGFLOW_CX_PROJECT_ID, dialogflowAgentId: DIALOGFLOW_CX_AGENT_ID, autoResponseStatus: 'ENABLED' } }; // Setup the parameters for the API call const apiParams = { auth: authClient, parent: agentName, resource: integrationObject }; bcApi.brands.agents.integrations.create(apiParams, {}, (err, response) => { if (err !== undefined && err !== null) { console.dir(err); } else { // Agent created console.log(response.data); } }); } else { console.log('Authentication failure.'); } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();
Питон
"""This code snippet creates a Dialogflow CX integration. Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#dialogflow_cx This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( BusinesscommunicationsBrandsAgentsIntegrationsCreateRequest, DialogflowCxIntegration ) # Edit the values below: BRAND_ID = 'EDIT_HERE' AGENT_ID = 'EDIT_HERE' DIALOGFLOW_CX_AGENT_ID = 'EDIT_HERE' DIALOGFLOW_CX_PROJECT_ID = 'EDIT_HERE' SCOPES = ['https://www.googleapis.com/auth/businesscommunications'] SERVICE_ACCOUNT_FILE = './service_account_key.json' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) integrations_service = BusinesscommunicationsV1.BrandsAgentsIntegrationsService(client) agent_name = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID integration = integrations_service.Create(BusinesscommunicationsBrandsAgentsIntegrationsCreateRequest( integration=DialogflowCxIntegration( autoResponseStatus=DialogflowCxIntegration.AutoResponseStatusValueValuesEnum.ENABLED, dialogflowAgentId=DIALOGFLOW_CX_AGENT_ID, dialogflowProjectId=DIALOGFLOW_CX_PROJECT_ID ), parent=agent_name )) print(integration)
Параметры форматирования и значений см. в разделе
Integration.
Подключение Business Messages и Dialogflow занимает около двух минут. Чтобы проверить статус интеграции, получите OperationInfo интеграции.
Обновите интеграцию
Чтобы обновить настройки автоответчика вашего агента, выполните следующую команду. Замените AUTO_RESPONSE_STATUS на ENABLED или DISABLED в зависимости от того, хотите ли вы, чтобы Business Messages автоматически отвечала пользователям с помощью ответов Dialogflow.
Диалоговый поток ES
КУЛЬ
# This code updates the Dialogflow association. # Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/updateDialogflowAssociation # Replace the __BRAND_ID__ and __AGENT_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X PATCH \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/dialogflowAssociation?updateMask=enableAutoResponse" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \ -d '{ "enableAutoResponse": true }'
Диалоговый поток CX
КУЛЬ
# This code updates the Dialogflow association. # Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/updateDialogflowAssociation # Replace the __BRAND_ID__ and __AGENT_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X PATCH \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/dialogflowAssociation?updateMask=enableAutoResponse" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \ -d '{ "enableAutoResponse": true }'
Параметры форматирования и значений см. в разделе Integration .
Переключение между редакциями Dialogflow
Агент Business Messages может одновременно поддерживать только одну интеграцию Dialogflow. Чтобы переключиться с одной версии Dialogflow на другую, вам необходимо удалить текущую интеграцию перед созданием новой.
Удалить интеграцию
Если вам нужно удалить Dialogflow из вашего агента Business Messages, удалите интеграцию с помощью следующей команды.
КУЛЬ
# This code deletes an integration. # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#delete_the_integration # Replace the __BRAND_ID__, __AGENT_ID__ and __INTEGRATION_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X DELETE \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/integrations/__INTEGRATION_ID__" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)"
Node.js
/** * This code snippet deletes an integration. * Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#delete_the_integration * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const BRAND_ID = 'EDIT_HERE'; const AGENT_ID = 'EDIT_HERE'; const INTEGRATION_ID = 'EDIT_HERE'; const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json'; const businesscommunications = require('businesscommunications'); const {google} = require('googleapis'); const uuidv4 = require('uuid').v4; // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ 'https://www.googleapis.com/auth/businesscommunications', ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); const integrationName = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID + '/integrations/' + INTEGRATION_ID; if (authClient) { // Setup the parameters for the API call const apiParams = { auth: authClient, name: integrationName, }; bcApi.brands.agents.integrations.delete(apiParams, {}, (err, response) => { if (err !== undefined && err !== null) { console.dir(err); } else { // Agent created console.log(response.data); } }); } else { console.log('Authentication failure.'); } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();
Питон
"""This code snippet deletes an integration. Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#delete_the_integration This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( BusinesscommunicationsBrandsAgentsIntegrationsDeleteRequest ) # Edit the values below: BRAND_ID = 'EDIT_HERE' AGENT_ID = 'EDIT_HERE' INTEGRATION_ID = 'EDIT_HERE' SCOPES = ['https://www.googleapis.com/auth/businesscommunications'] SERVICE_ACCOUNT_FILE = './service_account_key.json' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) integrations_service = BusinesscommunicationsV1.BrandsAgentsIntegrationsService(client) integration_name = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID + '/integrations/' + INTEGRATION_ID integration = integrations_service.Delete(BusinesscommunicationsBrandsAgentsIntegrationsDeleteRequest( name=integration_name )) print(integration)
Параметры форматирования и значений см. в разделе Integration .
Получить информацию об интеграции
Чтобы получить информацию об интеграции, вы можете использовать API бизнес-коммуникаций, если у вас есть значение name интеграции.
Получить информацию для одной интеграции
Чтобы получить информацию об интеграции, выполните следующую команду.
КУЛЬ
# This code gets information about an integration. # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#get_info_for_a_single_integration # Replace the __BRAND_ID__, __AGENT_ID__ and __INTEGRATION_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X GET \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/integrations/__INTEGRATION_ID__" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)"
Node.js
/** * This code snippet gets information about an integration. * Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#get_info_for_a_single_integration * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const BRAND_ID = 'EDIT_HERE'; const AGENT_ID = 'EDIT_HERE'; const INTEGRATION_ID = 'EDIT_HERE'; const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json'; const businesscommunications = require('businesscommunications'); const {google} = require('googleapis'); const uuidv4 = require('uuid').v4; // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ 'https://www.googleapis.com/auth/businesscommunications', ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); const integrationName = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID + '/integrations/' + INTEGRATION_ID; if (authClient) { // Setup the parameters for the API call const apiParams = { auth: authClient, name: integrationName, }; bcApi.brands.agents.integrations.get(apiParams, {}, (err, response) => { if (err !== undefined && err !== null) { console.dir(err); } else { // Agent created console.log(response.data); } }); } else { console.log('Authentication failure.'); } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();
Питон
"""This code snippet gets information about an integration. Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#get_info_for_a_single_integration This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( BusinesscommunicationsBrandsAgentsIntegrationsDeleteRequest ) # Edit the values below: BRAND_ID = 'EDIT_HERE' AGENT_ID = 'EDIT_HERE' INTEGRATION_ID = 'EDIT_HERE' SCOPES = ['https://www.googleapis.com/auth/businesscommunications'] SERVICE_ACCOUNT_FILE = './service_account_key.json' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) integrations_service = BusinesscommunicationsV1.BrandsAgentsIntegrationsService(client) integration_name = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID + '/integrations/' + INTEGRATION_ID integration = integrations_service.Get(BusinesscommunicationsBrandsAgentsIntegrationsDeleteRequest( name=integration_name )) print(integration)
Параметры форматирования и значений см. в разделе Integration .
Список всех интеграций для агента
Если вы не знаете имя интеграции, вы можете получить информацию обо всех интеграциях, связанных с агентом, опустив значение INTEGRATION_ID в URL-адресе запроса GET.
КУЛЬ
# This code lists all integrations for an agent. # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#list_all_integrations_for_an_agent # Replace the __BRAND_ID__ and __AGENT_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X GET \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/integrations" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)"
Node.js
/** * This code snippet lists all integrations for an agent. * Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#list_all_integrations_for_an_agent * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const BRAND_ID = 'EDIT_HERE'; const AGENT_ID = 'EDIT_HERE'; const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json'; const businesscommunications = require('businesscommunications'); const {google} = require('googleapis'); const uuidv4 = require('uuid').v4; // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ 'https://www.googleapis.com/auth/businesscommunications', ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); if (authClient) { // Setup the parameters for the API call const apiParams = { auth: authClient, parent: 'brands/' + BRAND_ID + '/agents/' + AGENT_ID, }; bcApi.brands.agents.integrations.list(apiParams, {}, (err, response) => { if (err !== undefined && err !== null) { console.dir(err); } else { // Agent created console.log(response.data); } }); } else { console.log('Authentication failure.'); } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();
Питон
"""This code snippet lists all integrations for an agent. Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#list_all_integrations_for_an_agent This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( BusinesscommunicationsBrandsAgentsIntegrationsListRequest ) # Edit the values below: BRAND_ID = 'EDIT_HERE' AGENT_ID = 'EDIT_HERE' SCOPES = ['https://www.googleapis.com/auth/businesscommunications'] SERVICE_ACCOUNT_FILE = './service_account_key.json' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) integrations_service = BusinesscommunicationsV1.BrandsAgentsIntegrationsService(client) agent_name = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID integration = integrations_service.List( BusinesscommunicationsBrandsAgentsIntegrationsListRequest(parent=agent_name) ) print(integration)
Параметры форматирования и значений см. в разделе Integration .
Соответствие намерений
После включения интеграции Dialogflow для агента Business Messages ваш агент сможет использовать настроенные намерения вашего проекта Dialogflow, чтобы понимать вопросы пользователей и отвечать на них без необходимости писать код. Чтобы узнать больше о намерениях, см. документацию для Dialogflow ES и Dialogflow CX .
Настройте намерения Dialogflow для каждого варианта диалога, который вы собираетесь поддерживать посредством автоматизации. Агенты Business Messages полагаются на Dialogflow для понимания сообщений пользователей.
При вызове API-интерфейсов Dialogflow Business Messages передает полезные данные пользовательского сообщения в ваши намерения и веб-перехватчик выполнения. Если сообщение пользователя соответствует намерению, вы можете получить доступ к этим полезным данным в формате Struct в поле business_messages_payload в QueryParameters .
Полезная нагрузка содержит все поля из сообщения пользователя , кроме DialogflowResponse .
Для Dialogflow CX Business Messages также передает параметр сеанса channel со значением google_business_messages в ваши намерения, и вы можете ссылаться на него в своем агенте в следующем формате: $session.params.channel .
Этот параметр можно использовать для добавления условий к выполнению Dialogflow для поддержки нескольких каналов в одном агенте Dialogflow.
Дополнительные сведения о параметрах запроса см. в справочниках по Dialogflow ES и Dialogflow CX .
Предварительные условия
При создании моделей NLU в Dialogflow вы можете настроить различные типы ответов для намерения. Business Messages поддерживает ответ по умолчанию, который может включать следующее:
- Текст
- Пользовательская полезная нагрузка
- Передача управления живым агентом (только Dialogflow CX)
Пользовательские полезные данные должны соответствовать допустимому объекту ответа на сообщение JSON Business Messages . При настройке пользовательских ответов полезных данных для намерения Business Messages игнорирует следующие поля:
-
name -
messageId -
representative
См. следующие примеры ответов.
Текст с предложениями
{
"text": "Hello World!",
"fallback": "Hello World!\n\nReply with \"Hello\" or \"Hi!\"",
"suggestions": [
{
"reply": {
"text": "Hello",
"postbackData": "hello-formal"
}
},
{
"reply": {
"text": "Hi!",
"postbackData": "hello-informal"
}
}
]
}
Богатая карта
{
"fallback": "Hello, world!\nSent with Business Messages\n\nReply with \"Suggestion #1\" or \"Suggestion #2\"",
"richCard": {
"standaloneCard": {
"cardContent": {
"title": "Hello, world!",
"description": "Sent with Business Messages.",
"media": {
"height": "TALL",
"contentInfo":{
"altText": "Google logo",
"fileUrl": "https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png",
"forceRefresh": "false"
}
},
"suggestions": [
{
"reply": {
"text": "Suggestion #1",
"postbackData": "suggestion_1"
}
},
{
"reply": {
"text": "Suggestion #2",
"postbackData": "suggestion_2"
}
}
]
}
}
}
}
Карусель с богатыми карточками
{
"fallback": "Card #1\nThe description for card #1\n\nCard #2\nThe description for card #2\n\nReply with \"Card #1\" or \"Card #2\"",
"richCard": {
"carouselCard": {
"cardWidth": "MEDIUM",
"cardContents": [
{
"title": "Card #1",
"description": "The description for card #1",
"suggestions": [
{
"reply": {
"text": "Card #1",
"postbackData": "card_1"
}
}
],
"media": {
"height": "MEDIUM",
"contentInfo": {
"fileUrl": "https://my.files/cute-dog.jpg",
"forceRefresh": false
}
}
},
{
"title": "Card #2",
"description": "The description for card #2",
"suggestions": [
{
"reply": {
"text": "Card #2",
"postbackData": "card_2"
}
}
],
"media": {
"height": "MEDIUM",
"contentInfo": {
"fileUrl": "https://my.files/elephant.jpg",
"forceRefresh": false
}
}
}
]
}
}
}
Передача живого агента
{
"metadata": {}
}
Часто задаваемые вопросы по ботам
После включения интеграции Dialogflow ES для агента Business Messages вы можете создать бота для часто задаваемых вопросов. Когда вы предоставляете вопросы и ответы в виде поддерживаемого документа знаний, Business Messages и Dialogflow создают необходимую инфраструктуру для понимания вопросов пользователей и ответов на них без необходимости писать код.
Чтобы увидеть работу бота FAQ, пообщайтесь с ботом Business Messages FAQ Bot .
Предварительные условия
Прежде чем создавать бота для часто задаваемых вопросов, вам необходимо, чтобы ваши вопросы и ответы были доступны в виде информационного документа (максимум 50 МБ): общедоступного файла HTML или файла CSV.
Как правило, документы знаний
- В ответы можно включать ограниченную разметку, как указано в Rich text .
- Максимальный размер 50 МБ.
- Не должно превышать 2000 пар вопрос/ответ.
- Не поддерживайте повторяющиеся вопросы с разными ответами.
Для HTML-файлов
- Файлы с общедоступных URL-адресов должны быть просканированы индексатором поиска Google, чтобы они существовали в индексе поиска. Проверить это можно с помощью Google Search Console . Обратите внимание, что индексатор не поддерживает актуальность вашего контента. Вы должны явно обновлять свой документ при изменении исходного содержимого.
- Dialogflow удаляет HTML-теги из контента при создании ответов. По этой причине лучше избегать HTML-тегов и по возможности использовать простой текст.
- Файлы с одной парой вопрос/ответ не поддерживаются.
Для файлов CSV:
- Файлы должны содержать вопросы в первом столбце и ответы во втором, без заголовка.
- В качестве разделителей в файлах должны использоваться запятые.
Создать бота для часто задаваемых вопросов
Чтобы создать бота для часто задаваемых вопросов, вы сначала создаете базу знаний для хранения всех данных бота, а затем добавляете в свою базу знаний один или несколько документов с парами вопросов и ответов.
Создайте базу знаний
Чтобы создать базу знаний, выполните следующую команду. Замените BRAND_ID , AGENT_ID и INTEGRATION_ID уникальными значениями из name документа. Замените KNOWLEDGE_BASE_DISPLAY_NAME идентифицирующей строкой по вашему выбору.
После создания базы знаний вы можете создавать в ней документы .
КУЛЬ
# This code creates a knowledge base. # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#create-knowledge-base # Replace the __BRAND_ID__, __AGENT_ID__, __INTEGRATION_ID__ and __KNOWLEDGE_BASE_DISPLAY_NAME__ # Make sure a service account key file exists at ./service_account_key.json curl -X PATCH \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/integrations/__INTEGRATION_ID__?updateMask=dialogflowEsIntegration.dialogflowKnowledgeBases" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \ -d '{ "dialogflowEsIntegration": { "dialogflowKnowledgeBases": [ { "displayName": "__KNOWLEDGE_BASE_DISPLAY_NAME__" } ] } }'
Параметры форматирования и значений см. в DialogflowKnowledgebase .
Создать документ знаний
Чтобы создать документ знаний, выполните следующую команду.
Добавьте документ в список существующих документов или создайте новый список, если его еще нет. Список существующих документов должен включать в запрос значение name документа.
Публичный HTML-файл
Замените следующие переменные:
- BRAND_ID , AGENT_ID и INTEGRATION_ID с уникальными значениями из
nameинтеграции. - KNOWLEDGE_BASE_DISPLAY_NAME и DOCUMENT_DISPLAY_NAME с идентифицирующими строками по вашему выбору.
PUBLIC_URL с общедоступным URL-адресом документа знаний.
КУЛЬ
# This code creates a knowledge base document from an HTML document and adds it to the knowledge base. # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#create-document # Replace the __BRAND_ID__, __AGENT_ID__, __INTEGRATION_ID__, __KNOWLEDGE_BASE_DISPLAY_NAME__, __DOCUMENT_DISPLAY_NAME__ and __PUBLIC_URL__ # Make sure a service account key file exists at ./service_account_key.json curl -X PATCH \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/integrations/__INTEGRATION_ID__?updateMask=dialogflowEsIntegration.dialogflowKnowledgeBases" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \ -d '{ "dialogflowEsIntegration": { "dialogflowKnowledgeBases": [ { "displayName": "__KNOWLEDGE_BASE_DISPLAY_NAME__", "documents": [ { "displayName": "__DOCUMENT_DISPLAY_NAME__", "faqUrl": "__PUBLIC_URL__" } ] } ] } }'
Локальный CSV-файл
Замените следующие переменные:
- BRAND_ID , AGENT_ID и INTEGRATION_ID с уникальными значениями из
nameинтеграции. - KNOWLEDGE_BASE_DISPLAY_NAME и DOCUMENT_DISPLAY_NAME с идентифицирующими строками по вашему выбору.
CSV_RAW_BYTES с CSV-файлом в виде строки в кодировке Base64.
КУЛЬ
# This code creates a knowledge base document from a CSV document and adds it to the knowledge base. # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#create-document # Replace the __BRAND_ID__, __AGENT_ID__, __INTEGRATION_ID__, __KNOWLEDGE_BASE_DISPLAY_NAME__, __DOCUMENT_DISPLAY_NAME__ and __CSV_RAW_BYTES__ # Make sure a service account key file exists at ./service_account_key.json curl -X PATCH \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/integrations/__INTEGRATION_ID__?updateMask=dialogflowEsIntegration.dialogflowKnowledgeBases" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \ -d '{ "dialogflowEsIntegration": { "dialogflowKnowledgeBases": [ { "displayName": "__KNOWLEDGE_BASE_DISPLAY_NAME__", "documents": [ { "displayName": "__DOCUMENT_DISPLAY_NAME__", "rawContent": "__CSV_RAW_BYTES__" } ] } ] } }'
Параметры форматирования и значений см. в DialogflowKnowledgebase .
Добавление документа в базу знаний занимает около двух минут. Чтобы проверить статус документа, получите OperationInfo интеграции.
Удаление документа знаний
Если вам нужно удалить пары вопросов и ответов из вашего агента Business Messages, удалите документ знаний, который их содержит, с помощью следующей команды.
Запустите следующую команду, чтобы удалить один существующий документ. Замените BRAND_ID , AGENT_ID и INTEGRATION_ID уникальными значениями из name документа. Замените KNOWLEDGE_BASE_DISPLAY_NAME соответствующей строкой.
КУЛЬ
# This code deletes a knowledge base document. # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/dialogflow?method=api#delete_a_knowledge_document # Replace the __BRAND_ID__, __AGENT_ID__, __INTEGRATION_ID__ and __KNOWLEDGE_BASE_DISPLAY_NAME__ # To delete all knowledge bases, set dialogflowKnowledgeBases to an empty list. Otherwise, the list should contain all existing knowledgebases except the one you would like to remove. # Make sure a service account key file exists at ./service_account_key.json curl -X PATCH \ "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/integrations/__INTEGRATION_ID__?updateMask=dialogflowEsIntegration.dialogflowKnowledgeBases" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \ -d '{ "dialogflowEsIntegration": { "dialogflowKnowledgeBases": [ { "displayName": "__KNOWLEDGE_BASE_DISPLAY_NAME__" } ] } }'
Параметры форматирования и значений см. в DialogflowKnowledgebase .
Автоответы
Если вы включите автоответ во время интеграции Dialogflow, Business Messages автоматически ответит пользователю через Dialogflow. Ваш агент Business Messages отвечает с наивысшим уровнем достоверности. При интеграции Dialogflow ES, если есть совпадения как с ответом на часто задаваемые вопросы, так и с пользовательским намерением, Business Messages отвечает совпадением, имеющим самый высокий уровень достоверности.
Business Messages помечает все сообщения с автоматическим ответом как исходящие от представителей BOT . Если ваш агент поддерживает живых агентов , Business Messages приостанавливает автоматические ответы после событий REPRESENTATIVE_JOINED и возобновляет автоматические ответы после событий REPRESENTATIVE_LEFT . См. Передача от бота к действующему агенту .
Автоматический ответ с ответом на часто задаваемые вопросы
При интеграции Dialogflow ES, если ответ на часто задаваемые вопросы имеет самый высокий уровень достоверности, Business Messages сопоставляет ответ с текстовым сообщением. Если доступен похожий, но другой ответ, в сообщении отображается предложение «Просмотреть другой ответ». В противном случае сообщение включает вопрос и предлагаемые ответы, спрашивающие, удовлетворяет ли сообщение запрос пользователя.
Автоматический ответ с намеренным ответом
Ответы на намерение могут включать в себя один или несколько из следующих ответов.
- Dialogflow ES: текст , пользовательские полезные данные
- Dialogflow CX: текст , пользовательские полезные данные , передача управления живым агентом
Если ответ о намерении имеет наивысший уровень достоверности, применяется следующее.
- Если в ответе есть хотя бы одно текстовое значение, Business Messages сопоставляет это значение с текстовым сообщением.
- Если ответ содержит хотя бы одну пользовательскую полезную нагрузку с допустимой структурой объекта JSON Business Messages, Business Messages создает сообщение, используя предоставленный объект JSON.
- Если в ответе содержится хотя бы один ответ на передачу обслуживания живого агента, см. раздел Автоматический ответ на запрос живого агента .
Поскольку Dialogflow может включать в себя несколько ответов в одном совпадении по намерению, Business Messages отправляет каждый текст, пользовательскую полезную нагрузку или ответ на передачу обслуживания живого агента как отдельное сообщение. Если в совпадении по намерению имеется несколько сообщений, но некоторые из них имеют неверный формат, Business Messages отправляет действительные сообщения только в качестве автоответов.
Автоматический ответ на запрос живого агента
Dialogflow CX поддерживает ответ на передачу обслуживания Live-агента . Он сигнализирует о том, что разговор следует передать представителю-человеку, и позволяет передавать пользовательские метаданные для процедуры передачи. Если ответ о намерении имеет наивысший уровень достоверности и включает передачу обслуживания Live-агента, Business Messages отправляет событие, запрошенное действующим агентом, на ваш веб-перехватчик. Чтобы обработать это событие, см. раздел Передача от бота к действующему агенту .
Автоматический ответ с резервным сообщением
Если Dialogflow не получает совпадения с высоким уровнем достоверности, Business Messages отправляет резервный ответ. Резервные варианты обрабатываются по-разному в Dialogflow ES и Dialogflow CX.
Диалоговый поток ES
Если для ботов часто задаваемых вопросов нет соответствия ответу на часто задаваемые вопросы, Business Messages отправляет резервное сообщение о том, что не удалось найти ответ.
Если для настроенных намерений нет соответствия ответу о намерении, Business Messages отправляет резервный ответ о намерении . Вы можете использовать резервный текст, предоставленный Dialogflow, или настроить резервный вариант с помощью дополнительного текста и пользовательских полезных данных.
Вот пример резервного ответа о намерении, который может получить ваш вебхук:
{
"intentResponses": [
{
"intentName": "projects/df-integration/agent/intents/12345",
"intentDisplayName": "Default Fallback Intent",
"intentDetectionConfidence": "1.0",
"fulfillmentMessages": [
{
"text": "One more time?"
}
]
}
]
}
Dialogflow предварительно заполняет intent_name и intent_display_name .
Диалоговый поток CX
Dialogflow CX обрабатывает ответы на резервные намерения как встроенные события . Если совпадения с ответом о намерении нет, Business Messages отправляет резервное сообщение из события по умолчанию «Нет соответствия» в Dialogflow. Вы можете использовать резервный текст, предоставленный Dialogflow, или настроить резервный вариант с дополнительным текстом, настраиваемыми полезными данными и параметрами передачи активного агента.
Вот пример резервного ответа о намерении, который может получить ваш вебхук:
{
"intentResponses": [
{
"intentName": "sys.no-match-default",
"intentDisplayName": "Default Fallback Intent",
"intentDetectionConfidence": "0.3",
"fulfillmentMessages": [
{
"text": "I missed that, say that again?"
}
]
}
]
}
В бизнес-сообщениях жестко запрограммированы intent_name и intent_display_name .
Поля, специфичные для Dialogflow
После включения интеграции Dialogflow пользовательские сообщения, получаемые агентом, включают объект dialogflowResponse . Ваш вебхук получает полезные данные для всех сообщений пользователя независимо от того, ответил ли Business Messages автоматически на сообщение от вашего имени. Чтобы проверить наличие автоответа, просмотрите значение поля autoResponded и решите, нужно ли вам отвечать пользователю.
Диалоговый поток ES
... "dialogflowResponse": { "queryText": "TEXT", "intentResponse": { "intentName": "INTENT_ID", "intentDisplayName": "INTENT_NAME", "intentDetectionConfidence": "CONFIDENCE_NUMERIC", "fulfillmentMessages": [{ "text": "FULFILLMENT_TEXT", "jsonPayload": "JSON", "error": "ERROR_STATUS", }], "faqResponse": { "userQuestion": "USER_QUESTION", "answers": [{ "faqQuestion": "FAQ_QUESTION", "faqAnswer": "FAQ_ANSWER", "matchConfidenceLevel": "CONFIDENCE_LEVEL", "matchConfidence": "CONFIDENCE_NUMERIC", }], }, "autoResponded": "BOOLEAN", "autoRespondedMessages": [{ "message": "MESSAGE_JSON", "responseSource": "SOURCE", }], }, ...
| Поле | Описание |
|---|---|
queryText | Исходный диалоговый текст запроса. Если для модели Dialogflow включено автоматическое исправление орфографии, queryText содержит исправленный пользовательский ввод. |
intentName | Уникальный идентификатор совпадающего намерения. |
intentDisplayName | Имя совпадающего намерения. |
intentDetectionConfidence | Числовой рейтинг достоверности соответствия между queryText и intentName . |
text | Текстовый ответ. |
jsonPayload | Пользовательский ответ полезной нагрузки. Эта строка соответствует пользовательским полезным данным, определенным в Dialogflow. Если полезная нагрузка не имеет допустимой структуры объекта Business Messages JSON, проблема описывает error . |
error | Описание ошибки с сообщением о выполнении намерения. |
userQuestion | Вопрос, заданный пользователем, анализируемый Dialogflow. |
faqQuestion | Вопрос из Dialogflow соответствует вопросу пользователя. |
faqAnswer | Ответ от Dialogflow соответствует вопросу пользователя. |
matchConfidenceLevel | Уровень достоверности совпадения между userQuestion и faqQuestion . |
matchConfidence | Числовой рейтинг уверенности в совпадении между userQuestion и faqQuestion . |
autoResponded | Независимо от того, автоматически ли Business Messages ответила пользователю ответом от Dialogflow. |
message | Полезная нагрузка автоответчика. |
responseSource | Источник автоответа. См. ResponseSource . |
Диалоговый поток CX
... "dialogflowResponse": { "queryText": "TEXT", "intentResponse": { "intentName": "INTENT_ID", "intentDisplayName": "INTENT_NAME", "intentDetectionConfidence": "CONFIDENCE_NUMERIC", "fulfillmentMessages": [{ "text": "FULFILLMENT_TEXT", "jsonPayload": "JSON", "error": "ERROR_STATUS", "liveAgentHandoff": { "metadata": {} } }], "autoResponded": "BOOLEAN", "autoRespondedMessages": [{ "message": "MESSAGE_JSON", "responseSource": "SOURCE", }], }, ...
| Поле | Описание |
|---|---|
queryText | Исходный диалоговый текст запроса. Если для модели Dialogflow включено автоматическое исправление орфографии, queryText содержит исправленный пользовательский ввод. |
intentName | Уникальный идентификатор совпадающего намерения. |
intentDisplayName | Имя совпадающего намерения. |
intentDetectionConfidence | Числовой рейтинг достоверности соответствия между queryText и intentName . |
text | Текстовый ответ. |
jsonPayload | Пользовательский ответ полезной нагрузки. Эта строка соответствует пользовательской полезной нагрузке, определенной в Dialogflow. Если полезные данные не имеют допустимой структуры объекта Business Messages JSON, проблема описывает error . |
error | Описание ошибки с сообщением о выполнении намерения. |
liveAgentHandoff | Пользовательские метаданные для процедуры передачи обслуживания действующего агента. |
autoResponded | Независимо от того, автоматически ли Business Messages ответила пользователю ответом от Dialogflow. |
message | Полезная нагрузка автоответчика. |
responseSource | Источник автоответа. См. ResponseSource . |