チャットボット: LUIS や QnA Maker サービスへの接続情報を .bot ファイルから取得する

const config = require('./config.js');

const LUIS_APP_NAME = 'maku-luis-sample';
const QNA_APP_NAME = 'maku-qna-sample';

const botEndpoint = config.loadBotEndpoint();  // ボット自体への接続情報
const luisEndpoint = config.loadLuisEndpoint(LUIS_APP_NAME);  // LUIS への接続情報
const qnaEndpoint = config.loadQnaEndpoint(QNA_APP_NAME);  // QnA Maker への接続情報

botEndpoint = {
  appId: '921c6a01-1948-0f4d-9a82-75daf6a6d43c',
  appPassword: '16lgoF+phvG:MPeg1eIDma*fcNU#!5jv',
  ...
}

luisEndpoint = {
  applicationId: 'c5514855-fa6b-8f4c-c695-9ac7d3519412',
  endpointKey: '9ccff1530f4214fd8e319434a1408fa2',
  endpoint: 'https://westus.api.cognitive.microsoft.com'
}

qnaEndpoint = {
  knowledgeBaseId: 'c78ec3e7-a58d-ca44-dbb6-e7805d8130c6',
  endpointKey: 'c9153f6c-980c-bd41-4ba6-370392cda0e8',
  host: 'https://maku-qna-sample.azurewebsites.net/qnamaker'
}

$ npm install botframework-config --save

class Config {
  /**
   * コンストラクタ。
   * 環境変数や .env ファイルに書かれた botFilePath や botFileSecret の
   * 情報を基に、.bot ファイルを読み込みます。
   */
  constructor() {
    const env = this._loadEnvFile();
    this.botEnv = env.botEnv;
    this.botConfig = this._loadBotFile(env.botFilePath, env.botFileSecret);
  }

  /**
   * 指定された Bot Endpoint (developement や production) への
   * 接続情報を取得します。
   */
  loadBotEndpoint() {
    // Get bot endpoint configuration by service name
    // Bot configuration as defined in .bot file
    const endpointConfig = this.botConfig.findServiceByNameOrId(this.botEnv);

    return {
      appId: endpointConfig.appId || process.env.microsoftAppID,
      appPassword: endpointConfig.appPassword || process.env.microsoftAppPassword,
      channelService: process.env.ChannelService,
      openIdMetadata: process.env.BotOpenIdMetadata,
    }
  }

  /**
   * 指定した LUIS アプリへの接続情報を取得します。
   * botbuilder-ai パッケージの LuisRecognizer クラスの
   * 初期化情報として使用することを想定しています。
   * 設定が見つからない場合は空のオブジェクトを返します。
   */
  loadLuisEndpoint(luisAppName) {
    const luisConfig = this.botConfig.findServiceByNameOrId(luisAppName);
    if (luisConfig == null) {
      return {};
    }

    // Map the contents to the required format for `LuisRecognizer`.
    return {
      applicationId: luisConfig.appId,
      endpointKey: luisConfig.subscriptionKey,
      endpoint: luisConfig.getEndpoint()
    };
  }

  /**
   * 指定した QnA Maker アプリへの接続情報を取得します。
   * botbuilder-ai パッケージの QnAMaker クラスの初期化情報として
   * 使用することを想定しています。
   * 設定が見つからない場合は空のオブジェクトを返します。
   */
  loadQnaEndpoint(qnaAppName) {
    const qnaConfig = this.botConfig.findServiceByNameOrId(qnaAppName);
    if (qnaConfig == null) {
      return {};
    }

    // Map the contents to the required format for `QnAMaker`.
    return {
      knowledgeBaseId: qnaConfig.kbId,
      endpointKey: qnaConfig.endpointKey,
      host: qnaConfig.hostname
    };
  }

  /**
   * .env ファイルの設定を環境変数 (process.env) とマージし、
   * .bot ファイルを読み込むための情報（パスなど）を返します。
   */
  _loadEnvFile() {
    const dotenv = require('dotenv');
    const path = require('path');
    const ROOT_DIR = __dirname;

    // Merge .env info to process.env
    dotenv.config({ path: path.join(ROOT_DIR, '.env') });

    return {
      // Absolute path of .bot file
      botFilePath: path.join(ROOT_DIR, (process.env.botFilePath || '')),
      // Secret key of .bot file
      botFileSecret: process.env.botFileSecret,
      // Name of the endpoint configuration section from the .bot file
      botEnv: process.env.NODE_ENV || 'development',
    }
  }

  /**
   * 暗号化された .bot ファイルを読み込みます。
   */
  _loadBotFile(botFilePath, botFileSecret) {
    const { BotConfiguration } = require('botframework-config');
    try {
      return BotConfiguration.loadSync(botFilePath, botFileSecret);
    } catch (err) {
      console.error('Error reading bot file.');
      console.error(err.message + '\n');
      console.error('Please ensure you have valid botFilePath' +
                    ' and botFileSecret set for your environment.');
      console.error('You can find the botFilePath and botFileSecret' +
                    ' in the Azure App Service application settings.');
      console.error('If you are running this bot locally, consider adding' +
                    ' a .env file with botFilePath and botFileSecret.');
      process.exit(1);
    }
  }
}

module.exports = new Config();

const { BotFrameworkAdapter } = require('botbuilder');
const config = require('./config.js');

const adapter = new BotFrameworkAdapter(config.loadBotEndpoint());

const { LuisRecognizer } = require('botbuilder-ai');
const config = require('./config.js');
const LUIS_APP_NAME = 'your-luis-app-name';

const luisEndpoint = config.loadLuisEndpoint(LUIS_APP_NAME);
const luisOptions = {
  includeAllIntents: true,
  log: true,
  staging: false
};
const luisRecognizer = new LuisRecognizer(luisEndpoint, luisOptions, true);

const { QnAMaker } = require('botbuilder-ai');
const config = require('./config.js');
const QNA_APP_NAME = 'your-qna-app-name';

const qnaEndpoint = config.loadQnaEndpoint(QNA_APP_NAME);
const qnaOptions = {};
const qnaMaker = new QnAMaker(qnaEndpoint, qnaOptions);