Skip to content

Latest commit

 

History

History
 
 

17.multilingual-bot

README.md

Multilingual Bot

Bot Framework v4 multilingual bot sample

This sample will present the user with a set of cards to pick their choice of language. The user can either change language by invoking the option cards, or by entering the language code (en/es). The bot will then acknowledge the selection.

This bot has been created using Bot Framework, it shows how to translate incoming and outgoing text using a custom middleware and the Microsoft Translator Text API.

Concepts introduced in this sample

Translation Middleware: We create a translation middleware that can translate text from bot to user and from user to bot, allowing the creation of multi-lingual bots.

The middleware is driven by user state. This means that users can specify their language preference, and the middleware automatically will intercept messages back and forth and present them to the user in their preferred language.

Users can change their language preference anytime, and since this gets written to the user state, the middleware will read this state and instantly modify its behavior to honor the newly selected preferred language.

The Microsoft Translator Text API, Microsoft Translator Text API is a cloud-based machine translation service. With this API you can translate text in near real-time from any app or service through a simple REST API call. The API uses the most modern neural machine translation technology, as well as offering statistical machine translation technology.

Prerequisites

  • .NET SDK version 6.0

    # determine dotnet version
dotnet --version

  • Microsoft Translator Text API key

    To consume the Microsoft Translator Text API, first obtain a key following the instructions in the Microsoft Translator Text API documentation.

    Paste the key in the TranslatorKey setting in the appsettings.json file, or use your preferred configuration and update the following line in Translation/MicrosoftTranslator.cs with your translation key:

To try this sample

  • Clone the repository

    git clone https://github.com/microsoft/botbuilder-samples.git

  • Run the bot from a terminal or from Visual Studio:

    A) From a terminal, navigate to samples/csharp_dotnetcore/17.multilingual-bot

    # run the bot
dotnet run

    B) Or from Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to samples/csharp_dotnetcore/17.multilingual-bot folder
    • Select MultiLingualBot.csproj file
    • Press F5 to run the project

Testing the bot using Bot Framework Emulator

Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.

  • Install the latest Bot Framework Emulator from here

Connect to the bot using Bot Framework Emulator

  • Launch Bot Framework Emulator
  • File -> Open Bot
  • Enter a Bot URL of http://localhost:3978/api/messages

Creating a custom middleware

Translation Middleware: We create a translation middleware than can translate text from bot to user and from user to bot, allowing the creation of multilingual bots. Users can specify their language preference, which is stored in the user state. The translation middleware translates to and from the user's preferred language.

Microsoft Translator Text API

The Microsoft Translator Text API, Microsoft Translator Text API is a cloud-based machine translation service. With this API you can translate text in near real-time from any app or service through a simple REST API call. The API uses the most modern neural machine translation technology, as well as offering statistical machine translation technology.

Deploy this bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Add TranslatorKey to Application Settings

If you used the appsettings.json file to store your TranslatorKey then you'll need to add this key and its value to the Application Settings for your deployed bot.

  • Log into the Azure portal
  • In the left nav, click on Bot Services
  • Click the <your_bot_name> Name to display the bots Web App Settings
  • Click the Application Settings
  • Scroll to the Application settings section
  • Click + Add new setting
  • Add the key TranslatorKey with a value of the Translator Text API Authentication key created from the steps above

Add TranslatorRegion to Application Settings

  • The Translator resource requires you to specify which Azure region your Translator region is in. If you have placed your Translator resource in an Azure region other than global, you must specify this region for your bot to be able to query the Translator resource. If TranslatorRegion is left blank, the default region of global will be used.

Further reading