将Bing Web Search API与QnA聊天机器人集成

时间:2018-06-14 22:12:07

标签: node.js azure botframework

我正在使用QnA模板(Microsoft Azure)制作聊天机器人。基本上,用户提出问题,机器人将尝试在FAQ文档中找到答案。如果失败,我希望它使用用户的查询运行Bing搜索并回复最准确的答案。我发现这个使用Bing Web Search API的示例:https://docs.microsoft.com/en-us/azure/cognitive-services/bing-web-search/quickstarts/nodejs。现在,我只想让机器人回复搜索的第一个链接,例如。 但是,我不知道如何将链接中的代码与生成的QnA Bot代码(在Node.js中)合并:

var restify = require('restify');
var builder = require('botbuilder');
var botbuilder_azure = require("botbuilder-azure");
var builder_cognitiveservices = require("botbuilder-cognitiveservices");
var request = require('request');

// Setup Restify Server
var server = restify.createServer();
server.listen(process.env.port || process.env.PORT || 3978, function () {
    console.log('%s listening to %s', server.name, server.url); 
});

// Create chat connector for communicating with the Bot Framework Service
var connector = new builder.ChatConnector({
    appId: process.env.MicrosoftAppId,
    appPassword: process.env.MicrosoftAppPassword,
    openIdMetadata: process.env.BotOpenIdMetadata 
});

// Listen for messages from users 
server.post('/api/messages', connector.listen());

var tableName = 'botdata';
var azureTableClient = new botbuilder_azure.AzureTableClient(tableName, process.env['AzureWebJobsStorage']);
var tableStorage = new botbuilder_azure.AzureBotStorage({ gzipData: false }, azureTableClient);

// Create your bot with a function to receive messages from the user
var bot = new builder.UniversalBot(connector);
bot.set('storage', tableStorage);

// Recognizer and and Dialog for GA QnAMaker service
var recognizer = new builder_cognitiveservices.QnAMakerRecognizer({
    knowledgeBaseId: process.env.QnAKnowledgebaseId,
    authKey: process.env.QnAAuthKey || process.env.QnASubscriptionKey, // Backward compatibility with QnAMaker (Preview)
    endpointHostName: process.env.QnAEndpointHostName
});

var basicQnAMakerDialog = new builder_cognitiveservices.QnAMakerDialog({
    recognizers: [recognizer],
    defaultMessage: 'Sorry, I cannot find anything on that topic',
    qnaThreshold: 0.3
});

// Override the invokeAnswer function from QnAMakerDialog 
builder_cognitiveservices.QnAMakerDialog.prototype.invokeAnswer = function (session, recognizeResult, threshold, noMatchMessage) {
    var qnaMakerResult = recognizeResult;
    session.privateConversationData.qnaFeedbackUserQuestion = session.message.text;
    if (qnaMakerResult.score >= threshold && qnaMakerResult.answers.length > 0) {
        if (this.isConfidentAnswer(qnaMakerResult) || this.qnaMakerTools == null) {
            this.respondFromQnAMakerResult(session, qnaMakerResult);
            this.defaultWaitNextMessage(session, qnaMakerResult);
        }
        else {
            this.qnaFeedbackStep(session, qnaMakerResult);
        }
    }
    else {
        this.noMatch(session, noMatchMessage, qnaMakerResult);
    }
};

// API call to Bing
basicQnAMakerDialog.noMatch = function (session, noMatchMessage, qnaMakerResult) {
    var term = session.message.text;
    var key = 'i hid it';

    var options = {
            url: "https://api.cognitive.microsoft.com/bing/v7.0/search?q=" + term,
            method: 'GET',
            headers : {
        'Ocp-Apim-Subscription-Key' : key
    }
    }; 

    request(options, function(err,res, body){
        if(err){
            console.error(err);
            session.send(noMatchMessage);
        }
        body = JSON.parse(body);
        session.send("I found a thing: " + body["webPages"]["value"][0]["name"]);
    });
};

bot.dialog('basicQnAMakerDialog', basicQnAMakerDialog);

bot.dialog('/', //basicQnAMakerDialog);
        [ 
         function (session, results) {
             session.replaceDialog('basicQnAMakerDialog');
         },

         ]);

在bot.dialog里面的函数中,我想我应该添加一个条件,例如:如果机器人返回默认消息,打开一个网页并让" term"搜索是用户的最后一条消息。但是,我不知道如何准确编码,以及在哪里这样做。此外,我不知道如何退出replaceDialog函数,以便回复默认消息或FAQ中的答案以外的其他内容。

PS:我一般都没有很多javascript或web开发经验。任何帮助将不胜感激:)

1 个答案:

答案 0 :(得分:0)

您正在实施的内容涉及两个步骤,即提取出" noMatch" case到一个方法,这样你就可以发出一个完整的响应消息,然后是API调用本身。

" noMatch"方法

首先,您需要覆盖QnAMakerDialog中的invokeAnswer函数(除了为noMatch案例添加对单独方法的调用之外,此覆盖只会更改。)

builder_cognitiveservices.QnAMakerDialog.prototype.invokeAnswer = function (session, recognizeResult, threshold, noMatchMessage) {
        var qnaMakerResult = recognizeResult;
        session.privateConversationData.qnaFeedbackUserQuestion = session.message.text;
        if (qnaMakerResult.score >= threshold && qnaMakerResult.answers.length > 0) {
            if (this.isConfidentAnswer(qnaMakerResult) || this.qnaMakerTools == null) {
                this.respondFromQnAMakerResult(session, qnaMakerResult);
                this.defaultWaitNextMessage(session, qnaMakerResult);
            }
            else {
                this.qnaFeedbackStep(session, qnaMakerResult);
            }
        }
        else {
                this.noMatch(session, noMatchMessage, qnaMakerResult);
        }
    };

在此之后,您将像往常一样定义您的basicQnAMakerDialog,但考虑将默认消息字段用于错误情况或"未找到结果"。 (这并不重要,因为你可以随意决定你在noMatch方法中发回的内容,但在那里有默认值很好)

var basicQnAMakerDialog = new builder_cognitiveservices.QnAMakerDialog({
    recognizers: [recognizer],
    defaultMessage: 'Sorry, I can't find anything on that topic'
    qnaThreshold: 0.3
});

在此之后,您可以单独定义noMatch方法。

basicQnAMakerDialog.noMatch = function (session, noMatchMessage, qnaMakerResult) {
            session.send(noMatchMessage); //Contains the default message
            this.defaultWaitNextMessage(session, qnaMakerResult);
}

在这种方法中,我们可以调用API或基本上做我们想要的任何事情。

Credit to gliddell on this override

API调用。

在noMatch方法中,我们将对Bing进行API调用

basicQnAMakerDialog.noMatch = function (session, noMatchMessage, qnaMakerResult) {
    var term = session.message.text;
    var key = <Environment Var containing the Bing key>;

    var options = {
        url: "https://api.cognitive.microsoft.com/bing/v7.0/search?q=" + term,
        method: 'GET',
        headers : {
            'Ocp-Apim-Subscription-Key' : key
        }
    }; 
    request(options, function(err,res, body){
        if(err){
            console.error(err);
            session.send(noMatchMessage);
        }
        body = JSON.parse(body);
        session.send("I found a thing: " + body["webPages"]["value"][0]["name"]);
    });
};

您可以在从搜索中获得结果后,根据需要自定义要发回的邮件。