Основная цель создания любого бота — ведение осмысленного диалога с пользователем. Лучший способ достичь этой цели — сделать так, чтобы с момента присоединения к диалогу пользователь знал о предназначении вашего бота, его возможностях и причинах создания. В этой статье представлены примеры кода, которые помогут создать приветствие, отправляемое ботом пользователю.
Примечание.
Пакеты SDK для JavaScript, C# и Python для Bot Framework по-прежнему будут поддерживаться. Однако пакет SDK для Java снимается с поддержки, и окончательная долгосрочная поддержка завершится в ноябре 2023 года.
Существующие боты, созданные с помощью пакета SDK для Java, будут продолжать функционировать.
Копия примера для приветствия пользователя в любом из следующих примеров: Пример C#, Пример JS, Пример Java или Пример Python. На примере кода в этой статье мы опишем, как отправлять приветственные сообщения.
Сведения о примере кода
В этом примере кода показано, как обнаруживать и приветствовать новых пользователей при первоначальном подключении к боту. На следующей схеме показан поток логики для такого бота.
OnMembersAddedAsyncвызывается при подключении нового пользователя к боту.
OnMessageActivityAsyncвызывается, когда бот получает новые входные данные пользователя.
Каждый раз, когда подключается новый пользователь, бот предоставляет ему WelcomeMessage, InfoMessage и PatternMessage.
При получении данных от нового пользователя бот проверяет WelcomeUserState и выясняет, имеет ли DidBotWelcomeUser значение true. Если это не так, пользователю возвращается начальное приветственное сообщение.
Два основных события, отслеживаемые ботом:
onMembersAddedвызывается при подключении нового пользователя к боту.
onMessageвызывается, когда бот получает новые входные данные пользователя.
Каждый раз, когда подключается новый пользователь, бот предоставляет ему welcomeMessage, infoMessage и patternMessage.
При получении данных от нового пользователя бот проверяет welcomedUserProperty и выясняет, имеет ли didBotWelcomeUser значение TRUE. Если это не так, он возвращает новому пользователю сообщение с приветствием.
Если DidBotWelcomeUser имеет значение true, входные данные пользователя оцениваются. В зависимости от содержания этих данных бот выполняет одно из следующих действий:
Повторите приветствие, полученное от пользователя.
Отобразите карточку героя, предоставляющую дополнительную информацию о ботах.
Переотправьте WelcomeMessage, описывающий ожидаемые входные данные для этого бота.
Два основных события, отслеживаемые ботом:
onMembersAddedвызывается при подключении нового пользователя к боту.
onMessageActivityвызывается, когда бот получает новые входные данные пользователя.
Каждый раз, когда подключается новый пользователь, ему предоставляется WELCOME_MESSAGE, INFO_MESSAGE и PATTERN_MESSAGE ботом.
При получении данных от нового пользователя бот проверяет WelcomeUserState и выясняет, имеет ли getDidBotWelcomeUser() значение true. Если это не так, он возвращает новому пользователю сообщение с приветствием.
Два основных события, отслеживаемые ботом:
on_members_added_activityвызывается при подключении нового пользователя к боту.
on_message_activityвызывается, когда бот получает новые входные данные пользователя.
Каждый раз, когда новый пользователь подключен, он получает от бота приветственное сообщение, информационное сообщение и шаблон сообщения.
При получении нового пользовательского ввода проверяется свойство welcome_user_state.did_welcome_user. Если оно не установлено в значение true, пользователю возвращается начальное приветственное сообщение. Если задано значение true, на основе содержимого входных данных пользователя этот бот выполнит одно из следующих действий:
Повторите приветствие, полученное от пользователя.
Отображает герой-карточку с дополнительной информацией о ботах.
В момент запуска создается объект состояния пользователя, а в конструктор бота добавляются зависимости.
Startup.cs
// Create the Bot Framework Authentication to be used with the Bot Adapter.
services.AddSingleton<BotFrameworkAuthentication, ConfigurationBotFrameworkAuthentication>();
// Create the Bot Adapter with error handling enabled.
Bots\WelcomeUserBot.cs
// Initializes a new instance of the "WelcomeUserBot" class.
public WelcomeUserBot(UserState userState)
{
_userState = userState;
}
При запуске состояние пользователя определяется в index.js и потребляется конструктором бота.
index.js
// Create HTTP server
const server = restify.createServer();
server.use(restify.plugins.bodyParser());
server.listen(process.env.port || process.env.PORT || 3978, function() {
console.log(`\n${ server.name } listening to ${ server.url }`);
console.log('\nGet Bot Framework Emulator: https://aka.ms/botframework-emulator');
Объект состояния пользователя создается при запуске и внедряется в конструктор бота контейнером Spring с помощью инъекции зависимости.
Application.java
Предупреждение
Похоже, образец, который вы ищете, переместился! Будьте уверены, что мы работаем над решением этого.
WelcomeUserBot.java
Предупреждение
Похоже, что образец, который вы ищете, был перемещён! Будьте уверены, что мы работаем над решением этого.
При запуске в app.py определяется состояние пользователя, которое затем используется конструктором бота.
app.py
# Create the Bot
BOT = WelcomeUserBot(USER_STATE)
# Listen for incoming requests on /api/messages.
Теперь мы создадим метод доступа к свойству, который предоставит нам ссылку на WelcomeUserState в методе OnMessageActivityAsync.
Затем мы вызовем метод GetAsync, чтобы получить ключ с правильной областью действия. Мы будем сохранять данные о состоянии пользователя после каждого цикла обработки введенных пользователем данных с помощью метода SaveChangesAsync.
Bots\WelcomeUserState.cs
// Gets or sets whether the user has been welcomed in the conversation.
public bool DidBotWelcomeUser { get; set; } = false;
Bots\WelcomeUserBot.cs
var didBotWelcomeUser = await welcomeUserStateAccessor.GetAsync(turnContext, () => new WelcomeUserState(), cancellationToken);
this.onMessage(async (context, next) => {
// Read UserState. If the 'DidBotWelcomedUser' does not exist (first time ever for a user)
// set the default to false.
const didBotWelcomedUser = await this.welcomedUserProperty.get(context, false);
/**
* Override the ActivityHandler.run() method to save state changes after the bot logic completes.
*/
async run(context) {
await super.run(context);
// Save state changes
await this.userState.saveChanges(context);
}
Теперь мы создаём акцессор свойства, предоставляющий нам доступ к WelcomeUserState внутри метода onMessageActivity.
Затем мы вызовем метод get, чтобы получить ключ с правильной областью действия. Мы будем сохранять данные о состоянии пользователя после каждого цикла обработки введенных пользователем данных с помощью метода saveChanges.
WelcomeUserBot.java
Предупреждение
Похоже, образец, который вы ищете, был перемещен! Будьте уверены, что мы работаем над решением этого.
Предупреждение
Похоже, что образец, который вы ищете, был перемещен! Будьте уверены, что мы работаем над решением этого.
В этом примере создается метод доступа к свойству состояния диалога (user_state_accessor) в конструкторе бота.
Он использует метод доступа к свойству в обработчике on_message_activity и переопределяет поведение обработчика on_turn, чтобы сохранить состояние перед завершением итерации.
# Get the state properties from the turn context.
welcome_user_state = await self.user_state_accessor.get(
turn_context, WelcomeUserState
)
async def on_turn(self, turn_context: TurnContext):
await super().on_turn(turn_context)
# save changes to WelcomeUserState after each turn
await self._user_state.save_changes(turn_context)
Обнаружение и приветствие новых подключенных пользователей
В WelcomeUserBot мы проверяем обновление действия с помощью OnMembersAddedAsync(), чтобы узнать, добавлен ли новый пользователь в диалог. Затем мы отправляем ему набор из трех приветственных сообщений: WelcomeMessage, InfoMessage и PatternMessage. Ниже приведен полный код для этого взаимодействия.
Bots\WelcomeUserBot.cs
public class WelcomeUserBot : ActivityHandler
{
// Messages sent to the user.
private const string WelcomeMessage = "This is a simple Welcome Bot sample. This bot will introduce you " +
"to welcoming and greeting users. You can say 'intro' to see the " +
"introduction card. If you are running this bot in the Bot Framework " +
"Emulator, press the 'Start Over' button to simulate user joining " +
"a bot or a channel";
private const string InfoMessage = "You are seeing this message because the bot received at least one " +
"'ConversationUpdate' event, indicating you (and possibly others) " +
"joined the conversation. If you are using the emulator, pressing " +
"the 'Start Over' button to trigger this event again. The specifics " +
"of the 'ConversationUpdate' event depends on the channel. You can " +
"read more information at: " +
"https://aka.ms/about-botframework-welcome-user";
private const string LocaleMessage = "You can use the activity's 'GetLocale()' method to welcome the user " +
"using the locale received from the channel. " +
"If you are using the Emulator, you can set this value in Settings.";
{
foreach (var member in membersAdded)
{
if (member.Id != turnContext.Activity.Recipient.Id)
{
await turnContext.SendActivityAsync($"Hi there - {member.Name}. {WelcomeMessage}", cancellationToken: cancellationToken);
await turnContext.SendActivityAsync(InfoMessage, cancellationToken: cancellationToken);
await turnContext.SendActivityAsync($"{LocaleMessage} Current locale is '{turnContext.Activity.GetLocale()}'.", cancellationToken: cancellationToken);
await turnContext.SendActivityAsync(PatternMessage, cancellationToken: cancellationToken);
}
}
}
Этот код JavaScript отправляет начальное приветственное сообщение при добавлении пользователя. Для этого мы проверяем, является ли диалог активным и добавлен ли новый участник в диалог.
bots/welcomeBot.js
// Sends welcome messages to conversation members when they join the conversation.
// Messages are only sent to conversation members who aren't the bot.
this.onMembersAdded(async (context, next) => {
// Iterate over all new members added to the conversation
for (const idx in context.activity.membersAdded) {
// Greet anyone that was not the target (recipient) of this message.
// Since the bot is the recipient for events from the channel,
// context.activity.membersAdded === context.activity.recipient.Id indicates the
// bot was added to the conversation, and the opposite indicates this is a user.
if (context.activity.membersAdded[idx].id !== context.activity.recipient.id) {
await context.sendActivity(`Welcome to the 'Welcome User' Bot. This bot will introduce you to welcoming and greeting users.`);
await context.sendActivity(`You are seeing this message because the bot received at least one 'ConversationUpdate' ` +
`event, indicating you (and possibly others) joined the conversation. If you are using the emulator, ` +
`pressing the 'Start Over' button to trigger this event again. The specifics of the 'ConversationUpdate' ` +
`event depends on the channel. You can read more information at https://aka.ms/about-botframework-welcome-user`);
await context.sendActivity(`You can use the activity's 'locale' property to welcome the user ` +
`using the locale received from the channel. ` +
`If you are using the Emulator, you can set this value in Settings. ` +
`Current locale is '${ context.activity.locale }'`);
await context.sendActivity(`It is a good pattern to use this event to send general greeting to user, explaining what your bot can do. ` +
`In this example, the bot handles 'hello', 'hi', 'help' and 'intro'. ` +
`Try it now, type 'hi'`);
}
}
// By calling next() you ensure that the next BotHandler is run.
await next();
});
В WelcomeUserBot мы проверяем обновление действия с помощью onMembersAdded(), чтобы узнать, добавлен ли новый пользователь в диалог. Затем мы отправляем ему набор из трех приветственных сообщений: WELCOME_MESSAGE, INFO_MESSAGE и PATTERN_MESSAGE. Ниже приведен полный код для этого взаимодействия.
WelcomeUserBot.java
Предупреждение
Похоже, образец, который вы ищете, переместился! Будьте уверены, что мы работаем над решением этого.
Предупреждение
Похоже, образец, который вы ищете, был перемещён! Будьте уверены, что мы работаем над решением этого.
on_members_added_activity проверяет, добавлен ли новый пользователь, а затем отправляет три начальных приветственных сообщения: приветственное сообщение, информационное сообщение и сообщение-шаблон.
bots/welcome-user-bot.py
"""
Greet when users are added to the conversation.
Note that all channels do not send the conversation update activity.
If you find that this bot works in the emulator, but does not in
another channel the reason is most likely that the channel does not
send this activity.
"""
for member in members_added:
if member.id != turn_context.activity.recipient.id:
await turn_context.send_activity(
f"Hi there { member.name }. " + self.WELCOME_MESSAGE
)
await turn_context.send_activity(self.INFO_MESSAGE)
await turn_context.send_activity(
f"{ self.LOCALE_MESSAGE } Current locale is { turn_context.activity.locale }."
)
await turn_context.send_activity(self.PATTERN_MESSAGE)
Приветствие нового пользователя и удаление первого входящего сообщения
Также важно учитывать, когда входные данные пользователя могут на самом деле содержать полезные сведения, и это может отличаться для каждого канала. Чтобы убедиться, что у пользователя положительный опыт на всех возможных каналах, мы проверяем флаг состояния didBotWelcomeUser и если это "false", мы не обрабатываем изначальные данные пользователя. Вместо этого мы предоставляем пользователю начальное приветственное сообщение. Затем мы присваиваем значение true свойству welcomedUserProperty, которое хранится в UserState, и с этого момента наш код будет обрабатывать введенные этим пользователем данные от всех дополнительных действий сообщения.
Bots\WelcomeUserBot.cs
{
var welcomeUserStateAccessor = _userState.CreateProperty<WelcomeUserState>(nameof(WelcomeUserState));
var didBotWelcomeUser = await welcomeUserStateAccessor.GetAsync(turnContext, () => new WelcomeUserState(), cancellationToken);
if (didBotWelcomeUser.DidBotWelcomeUser == false)
{
didBotWelcomeUser.DidBotWelcomeUser = true;
// the channel should sends the user name in the 'From' object
var userName = turnContext.Activity.From.Name;
await turnContext.SendActivityAsync("You are seeing this message because this was your first message ever to this bot.", cancellationToken: cancellationToken);
await turnContext.SendActivityAsync($"It is a good practice to welcome the user and provide personal greeting. For example, welcome {userName}.", cancellationToken: cancellationToken);
}
else
Также важно учитывать, когда входные данные пользователя могут на самом деле содержать полезные сведения, и это может отличаться для каждого канала. Чтобы убедиться, что у пользователя есть хороший опыт на всех возможных каналах, мы проверяем свойство didBotWelcomedUser, если оно не существует, мы зададим его значение false и не обрабатываем исходные входные данные пользователя. Вместо этого мы предоставляем пользователю начальное приветственное сообщение. Затем для didBotWelcomeUser устанавливается значение true, и наш код обрабатывает введенные пользователем данные от всех дополнительных действий сообщения.
bots/welcomeBot.js
this.onMessage(async (context, next) => {
// Read UserState. If the 'DidBotWelcomedUser' does not exist (first time ever for a user)
// set the default to false.
const didBotWelcomedUser = await this.welcomedUserProperty.get(context, false);
// Your bot should proactively send a welcome message to a personal chat the first time
// (and only the first time) a user initiates a personal chat with your bot.
if (didBotWelcomedUser === false) {
// The channel should send the user name in the 'From' object
const userName = context.activity.from.name;
await context.sendActivity('You are seeing this message because this was your first message ever sent to this bot.');
await context.sendActivity(`It is a good practice to welcome the user and provide personal greeting. For example, welcome ${ userName }.`);
// Set the flag indicating the bot handled the user's first message.
await this.welcomedUserProperty.set(context, true);
} else {
}
// By calling next() you ensure that the next BotHandler is run.
await next();
});
Важно учитывать, когда входные данные пользователя могут содержать полезные сведения, которые могут отличаться для каждого канала. Чтобы обеспечить пользователю хороший опыт на всех возможных каналах, мы проверяем флаг состояния getDidBotWelcomeUser и, если он равен "false", мы не обрабатываем исходные данные, введенные пользователем. Вместо этого мы предоставляем пользователю начальное приветственное сообщение. Затем логическое значение setDidBotWelcomeUser устанавливается в значение "true", сохраняется в UserState, и теперь наш код будет обрабатывать входные данные этого пользователя из всех дополнительных активностей сообщений.
WelcomeUserBot.java
Предупреждение
Похоже, образец, который вы ищете, был перемещён! Будьте уверены, что мы работаем над решением этого.
Предупреждение
Похоже, что образец, который вы ищете, был перемещен! Будьте уверены, что мы работаем над решением этого.
Также важно учитывать, когда входные данные пользователя могут содержать полезные сведения, это может отличаться для каждого канала. Чтобы обеспечить оптимальную работу пользователя на всех возможных каналах, on_message_activity проверяет свойство did_welcome_user. В первый раз он задает значение false и не обрабатывает входные данные пользователя. Вместо этого пользователю предоставляется начальное приветственное сообщение. Затем для did_welcome_user устанавливается значение true и обрабатываются введенные пользователем данные из всех дополнительных действий с сообщениями.
bots/welcome-user-bot.py
if not welcome_user_state.did_welcome_user:
welcome_user_state.did_welcome_user = True
await turn_context.send_activity(
"You are seeing this message because this was your first message ever to this bot."
)
name = turn_context.activity.from_property.name
await turn_context.send_activity(
f"It is a good practice to welcome the user and provide personal greeting. For example: Welcome {name}"
)
Обработка дополнительных входных данных
После приветствия нового пользователя вводная информация пользователя оценивается для каждого хода, и бот предоставляет ответ, основанный на контексте этих данных. Следующий код демонстрирует логику принятия решений, которая используется для создания ответа.
Ввод команд intro или help вызывает функцию SendIntroCardAsync, которая предоставляет пользователю информационную карточку. Этот код рассматривается в следующем разделе этой статьи.
Bots\WelcomeUserBot.cs
switch (text)
{
case "hello":
case "hi":
await turnContext.SendActivityAsync($"You said {text}.", cancellationToken: cancellationToken);
break;
case "intro":
case "help":
await SendIntroCardAsync(turnContext, cancellationToken);
break;
default:
await turnContext.SendActivityAsync(WelcomeMessage, cancellationToken: cancellationToken);
break;
}
}
Ввод "intro" или "help" используется с помощью CardFactory для предоставления пользователю вводной адаптивной карты. Этот код рассматривается в следующем разделе этой статьи.
bots/welcomeBot.js
// This example uses an exact match on user's input utterance.
// Consider using LUIS or QnA for Natural Language Processing.
const text = context.activity.text.toLowerCase();
switch (text) {
case 'hello':
case 'hi':
await context.sendActivity(`You said "${ context.activity.text }"`);
break;
case 'intro':
case 'help':
await this.sendIntroCard(context);
break;
default:
await context.sendActivity(`This is a simple Welcome Bot sample. You can say 'intro' to
see the introduction card. If you are running this bot in the Bot
Framework Emulator, press the 'Start Over' button to simulate user joining a bot or a channel`);
}
Ввод 'intro' или 'help' вызывает функцию sendIntroCard, которая предоставляет пользователю информационную карточку. Этот код рассматривается в следующем разделе этой статьи.
WelcomeUserBot.java
Предупреждение
Похоже, пример, который вы искали, уже перемещен! Будьте уверены, что мы работаем над решением этого.
Ввод пользователя введение или помощь заставляет бота вызвать __send_intro_card, который представляет пользователю вводную адаптивную карточку.
bots/welcome-user-bot.py
if text in ("hello", "hi"):
await turn_context.send_activity(f"You said { text }")
elif text in ("intro", "help"):
await self.__send_intro_card(turn_context)
else:
await turn_context.send_activity(self.WELCOME_MESSAGE)
Использование приветствия в карточке героя
Как упоминалось выше, в ответ на некоторые введенные пользователем данные создается героическая карта. Узнайте больше о приветствиях на карточках героя здесь Отправка вводной карточки. Ниже представлен код, который необходим для создания ответа с карточкой-героем этого бота.
{
var card = new HeroCard
{
Title = "Welcome to Bot Framework!",
Text = @"Welcome to Welcome Users bot sample! This Introduction card
is a great way to introduce your Bot to the user and suggest
some things to get them started. We use this opportunity to
recommend a few next steps for learning more creating and deploying bots.",
Images = new List<CardImage>() { new CardImage("https://aka.ms/bf-welcome-card-image") },
Buttons = new List<CardAction>()
{
new CardAction(ActionTypes.OpenUrl, "Get an overview", null, "Get an overview", "Get an overview", "https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0"),
new CardAction(ActionTypes.OpenUrl, "Ask a question", null, "Ask a question", "Ask a question", "https://stackoverflow.com/questions/tagged/botframework"),
new CardAction(ActionTypes.OpenUrl, "Learn how to deploy", null, "Learn how to deploy", "Learn how to deploy", "https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-howto-deploy-azure?view=azure-bot-service-4.0"),
}
};
var response = MessageFactory.Attachment(card.ToAttachment());
await turnContext.SendActivityAsync(response, cancellationToken);
}
}
bots/welcomeBot.js
async sendIntroCard(context) {
const card = CardFactory.heroCard(
'Welcome to Bot Framework!',
'Welcome to Welcome Users bot sample! This Introduction card is a great way to introduce your Bot to the user and suggest some things to get them started. We use this opportunity to recommend a few next steps for learning more creating and deploying bots.',
['https://aka.ms/bf-welcome-card-image'],
[
{
type: ActionTypes.OpenUrl,
title: 'Get an overview',
value: 'https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0'
},
{
type: ActionTypes.OpenUrl,
title: 'Ask a question',
value: 'https://stackoverflow.com/questions/tagged/botframework'
},
{
type: ActionTypes.OpenUrl,
title: 'Learn how to deploy',
value: 'https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-howto-deploy-azure?view=azure-bot-service-4.0'
}
]
);
await context.sendActivity({ attachments: [card] });
}
WelcomeUserBot.java
Предупреждение
Похоже, образец, который вы ищете, был перемещен! Будьте уверены, что мы работаем над решением этого.
bots/welcome-user-bot.py
async def __send_intro_card(self, turn_context: TurnContext):
card = HeroCard(
title="Welcome to Bot Framework!",
text="Welcome to Welcome Users bot sample! This Introduction card "
"is a great way to introduce your Bot to the user and suggest "
"some things to get them started. We use this opportunity to "
"recommend a few next steps for learning more creating and deploying bots.",
images=[CardImage(url="https://aka.ms/bf-welcome-card-image")],
buttons=[
CardAction(
type=ActionTypes.open_url,
title="Get an overview",
text="Get an overview",
display_text="Get an overview",
value="https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0",
),
CardAction(
type=ActionTypes.open_url,
title="Ask a question",
text="Ask a question",
display_text="Ask a question",
value="https://stackoverflow.com/questions/tagged/botframework",
),
CardAction(
type=ActionTypes.open_url,
title="Learn how to deploy",
text="Learn how to deploy",
display_text="Learn how to deploy",
value="https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-howto-deploy-azure?view=azure-bot-service-4.0",
),
],
)
return await turn_context.send_activity(
MessageFactory.attachment(CardFactory.hero_card(card))
)