Neste início rápido, você aprenderá a criar seu primeiro bot com o SDK do Bot Framework para C#, Java, JavaScript ou Python e como testar seu bot com o Bot Framework Emulator.
A criação do primeiro bot não requer uma assinatura do Azure nem um recurso de Serviço de Bot do Azure. Este início rápido se concentra na criação do primeiro bot localmente. Se você quiser saber como criar um bot no Azure, consulte Criar um recurso do Bot do Azure.
O pacote VSIX inclui as versões .NET Core 2.1 e .NET Core 3.1 dos modelos C#.
Ao criar novos bots no Visual Studio 2019 ou posterior, você deve usar os modelos do .NET Core 3.1.
Os exemplos de bot atuais usam modelos do .NET Core 3.1.
Encontre os exemplos que usam modelos do .NET Core 2.1 na ramificação 4.7-archive do repositório BotBuilder-Samples.
Para instalar os modelos em Visual Studio, na barra de menus superior, navegue até Extensões>Gerenciar Extensões. Em seguida, pesquise e instale o SDK do Bot Framework v4 para Visual Studio.
Para obter informações sobre como implantar bots do .NET Core 3.1 no Azure, confira como implantar seu bot no Azure.
Os modelos do .NET Core ajudarão você a criar rapidamente novos bots de IA de conversa usando o Bot Framework v4. A partir de maio de 2020, esses modelos e o código gerados exigem o .NET Core 3.1.
Você pode usar esse comando para determinar qual versão da interface de linha de comando do .NET Core você instalou.
dotnet --version
Instale os três modelos do Bot Framework C#: os modelos de eco, núcleo e bot vazios.
dotnet new -i Microsoft.Bot.Framework.CSharp.EchoBot
dotnet new -i Microsoft.Bot.Framework.CSharp.CoreBot
dotnet new -i Microsoft.Bot.Framework.CSharp.EmptyBot
Verifique se os modelos foram instalados corretamente.
dotnet new --list
Observação
As etapas de instalação acima instalarão todos os três modelos do Bot Framework. Você não precisa instalar todos os modelos e pode instalar apenas os que você usará. Este artigo usa o modelo de echo bot .
Uma conta do Azure se você quiser implantar no Azure.
Modelos
Use o gerador Yeoman para configurar rapidamente um bot de IA de conversa usando os principais recursos de IA no Bot Framework v4. Para obter mais informações, consulte yeoman.io.
O gerador dá suporte a três opções de modelo diferentes, conforme mostrado abaixo.
Modelo
Descrição
Echo Bot
Um bom modelo se você quiser um pouco mais do que "Olá, Mundo!", mas não muito mais. Esse modelo lida com os conceitos básicos de enviar mensagens para um bot e fazer com que o bot processe as mensagens repetindo-as de volta para o usuário. Esse modelo produz um bot que simplesmente "ecoa" de volta para o usuário tudo o que o usuário diz ao bot.
Bot vazio
Um bom modelo se você estiver familiarizado com o Bot Framework v4 e simplesmente quiser um projeto básico de esqueleto. Além disso, uma boa opção se você quiser tirar o código de exemplo da documentação e colá-lo em um bot mínimo para aprender.
Bot Principal
Um bom modelo se você quiser criar bots avançados, pois ele usa caixas de diálogo de vários turnos e o LUIS, um serviço cognitivo baseado em IA, para implementar a compreensão da linguagem. Esse modelo cria um bot que pode extrair locais e datas para reservar um voo.
Instalar o Yeoman
Verifique se você instalou node.js versão 12.10 ou posterior.
Conhecimento de restify e programação assíncrona em JavaScript
Visual Studio Code ou seu IDE favorito, se você quiser editar o código de bot.
Modelos
Para instalar o Yeoman e o gerador Yeoman para Bot Framework v4:
Abra um prompt de comandos com privilégios elevados ou terminais.
Alterne para o diretório dos seus bots do JavaScript. Crie-o primeiro se você ainda não tiver um.
mkdir myJsBots
cd myJsBots
Verifique se você tem as versões mais recentes de npm e Yeoman.
npm install -g npm
npm install -g yo
Instale o gerador Yeoman.
Yeoman é uma ferramenta para criar aplicativos. Para obter mais informações, consulte yeoman.io.
npm install -g generator-botbuilder
Observação
A instalação das ferramentas de compilação do Windows listadas abaixo só é necessária se você usar o Windows como seu sistema operacional de desenvolvimento.
Para algumas instalações, a etapa de instalação para restify está dando um erro relacionado a node-gyp.
Se esse for o caso, você poderá tentar executar esse comando com permissões elevadas.
Essa chamada também poderá ser interrompida sem sair se o Python já estiver instalado em seu sistema:
Execute este comando somente se você estiver no Windows.
Um ambiente virtual é uma combinação de um interpretador do Python específico e bibliotecas diferentes das configurações globais. O ambiente virtual é específico de um projeto e é mantido na pasta do projeto. Um benefício para o uso de um ambiente virtual é que, à medida que você desenvolve um projeto ao longo do tempo, o ambiente virtual sempre reflete as dependências exatas do projeto. Para saber mais sobre ambientes virtuais, consulte Criação de ambientes virtuais.
Navegue até o diretório onde você deseja criar seu bot. Em seguida, execute os comandos a seguir para sua plataforma preferida. Depois de ativar seu ambiente virtual, sua linha de comando/terminal deverá ser precedida com (venv). Isso permite que você saiba que o ambiente virtual está ativo. Você pode desativar seu ambiente virtual a qualquer momento digitando: deactivate. .
macOS/Linux
python3 -m venv venv
source venv/bin/activate
Windows
python -m venv venv
venv\Scripts\activate.bat
Modelos
Instale os pacotes necessários executando os seguintes pip install comandos:
No Visual Studio, crie um projeto de bot usando o modelo Echo Bot (Bot Framework v4 – .NET Core 3.1) . Para ver apenas modelos de bot, escolha Bots de IA entre os tipos de projeto.
Graças ao modelo, seu projeto contém todo o código necessário para criar o bot neste início rápido. Você não precisa de nenhum código adicional para testar o bot.
Em Visual Studio Code, abra uma nova janela de terminal.
Navegue até o diretório no qual você deseja criar seu projeto de bot.
Crie um novo projeto de bot de eco usando o comando a seguir. Substitua <your-bot-name> pelo nome a ser usado para seu projeto de bot.
dotnet new echobot -n <your-bot-name>
Abra uma nova janela de terminal.
Navegue até o diretório no qual você deseja criar seu projeto de bot.
Crie um novo projeto de bot de eco usando o comando a seguir. Substitua <your-bot-name> pelo nome a ser usado para seu projeto de bot.
dotnet new echobot -n <your-bot-name>
Dica
Se você criar um bot Principal :
Somente o diretório da solução recebe o nome do bot.
Você precisará de um modelo de linguagem LUIS. Você pode criar um modelo de idioma em luis.ai. Após a criação do modelo, atualize o arquivo de configuração.
Execute o comando a seguir para criar um bot de eco a partir de modelos. O comando usa opções padrão para seus parâmetros.
yo botbuilder-java -T "echo"
Yeoman pede-lhe alguma informação para criar o seu bot. Neste tutorial, use os valores padrão.
? What's the name of your bot? (echo)
? What's the fully qualified package name of your bot? (com.mycompany.echo)
? Which template would you like to start with? (Use arrow keys) Select "Echo Bot"
? Looking good. Shall I go ahead and create your new bot? (Y/n) Enter "y"
O gerador dá suporte a várias opções de linha de comando que podem ser usadas para alterar as opções padrão do gerador ou pré-propagar um prompt. As opções diferenciam maiúsculas de minúsculas.
Opção de linha de comando
Descrição
--help, -h
Listar texto de ajuda para todas as opções de linha de comando com suporte
O gerador não solicitará confirmação antes de criar um novo bot. Todas as opções de requisito não passadas na linha de comando usarão um valor padrão razoável. Essa opção destina-se a habilitar a geração automatizada de bots para fins de teste.
Graças ao modelo, seu projeto contém todo o código necessário para criar o bot neste início rápido. Você não precisa de nenhum código adicional para testar o bot.
Observação
Se você optar por criar um bot Core, será necessário um modelo de linguagem LUIS. Você pode criar um modelo de idioma em luis.ai. Após a criação do modelo, atualize o arquivo de configuração.
Yeoman pede-lhe alguma informação para criar o seu bot. Neste tutorial, use os valores padrão.
? What's the name of your bot? my-chat-bot
? What will your bot do? Demonstrate the core capabilities of the Microsoft Bot Framework
? What programming language do you want to use? JavaScript
? Which template would you like to start with? Echo Bot - https://aka.ms/bot-template-echo
? Looking good. Shall I go ahead and create your new bot? Yes
Graças ao modelo, seu projeto contém todo o código necessário para criar o bot neste início rápido. Você não precisa de nenhum código adicional para testar o bot.
Observação
Se você optar por criar um bot Core, será necessário um modelo de linguagem LUIS. Você pode criar um modelo de idioma em luis.ai. Após a criação do modelo, atualize o arquivo de configuração.
Isso vai compilar o aplicativo, implantá-lo no localhost e iniciar o navegador da Web para exibir a página default.htm do aplicativo. Neste ponto, o bot está sendo executado localmente na porta 3978.
Para executar o bot de VS Code:
Abra sua pasta de projeto de bot.
Se for solicitado que você selecione um projeto, selecione aquele para o bot que acabou de criar.
Vá para Executar e selecione Executar sem Depuração.
Selecione o ambiente de .Net Core.
Se esse comando atualizou as configurações de inicialização, salve as alterações e execute novamente o comando.
Isso vai compilar o aplicativo, implantá-lo no localhost e iniciar o navegador da Web para exibir a página default.htm do aplicativo. Neste ponto, o bot está sendo executado localmente na porta 3978.
Para executar o bot localmente em um prompt de comando ou terminal:
Altere os diretórios para a pasta de projeto do bot.
Use dotnet run para iniciar o bot.
dotnet run
Isso criará o aplicativo e o implantará no localhost. A página da Web padrão do aplicativo não será exibida, mas, neste momento, o bot está sendo executado localmente na porta 3978.
