From eb94c0d6c4c272f6f75503a503cca3bd579f5bc5 Mon Sep 17 00:00:00 2001 From: Tracy Boehrer Date: Mon, 28 Oct 2019 16:04:10 -0500 Subject: [PATCH 1/4] Added 08.suggested-actions --- samples/08.suggested-actions/README.md | 32 +++++++ .../adapter_with_error_handler.py | 31 +++++++ samples/08.suggested-actions/app.py | 58 ++++++++++++ samples/08.suggested-actions/bots/__init__.py | 6 ++ .../bots/suggested_actions_bot.py | 88 +++++++++++++++++++ samples/08.suggested-actions/config.py | 19 ++++ samples/08.suggested-actions/requirements.txt | 2 + 7 files changed, 236 insertions(+) create mode 100644 samples/08.suggested-actions/README.md create mode 100644 samples/08.suggested-actions/adapter_with_error_handler.py create mode 100644 samples/08.suggested-actions/app.py create mode 100644 samples/08.suggested-actions/bots/__init__.py create mode 100644 samples/08.suggested-actions/bots/suggested_actions_bot.py create mode 100644 samples/08.suggested-actions/config.py create mode 100644 samples/08.suggested-actions/requirements.txt diff --git a/samples/08.suggested-actions/README.md b/samples/08.suggested-actions/README.md new file mode 100644 index 000000000..f476c6889 --- /dev/null +++ b/samples/08.suggested-actions/README.md @@ -0,0 +1,32 @@ +# suggested actions + +Bot Framework v4 using adaptive cards bot sample + +This bot has been created using [Bot Framework](https://dev.botframework.com), it shows how to use suggested actions. Suggested actions enable your bot to present buttons that the user can tap to provide input. + +## Running the sample +- Clone the repository +```bash +git clone https://github.com/Microsoft/botbuilder-python.git +``` +- Run `pip install -r requirements.txt` to install all dependencies +- Run `python app.py` +- Alternatively to the last command, you can set the file in an environment variable with `set FLASK_APP=app.py` in windows (`export FLASK_APP=app.py` in mac/linux) and then run `flask run --host=127.0.0.1 --port=3978` + +### Visual studio code +- Activate your desired virtual environment +- Open `botbuilder-python\samples\45.state-management` folder +- Bring up a terminal, navigate to `botbuilder-python\samples\02.echo-bot` folder +- In the terminal, type `pip install -r requirements.txt` +- In the terminal, type `python app.py` + +## Testing the bot using Bot Framework Emulator +[Microsoft Bot Framework Emulator](https://github.com/microsoft/botframework-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 Bot Framework emulator from [here](https://github.com/Microsoft/BotFramework-Emulator/releases) + +### Connect to bot using Bot Framework Emulator +- Launch Bot Framework Emulator +- Paste this URL in the emulator window - http://localhost:3978/api/messages + +Suggested actions enable your bot to present buttons that the user can tap to provide input. Suggested actions appear close to the composer and enhance user experience. diff --git a/samples/08.suggested-actions/adapter_with_error_handler.py b/samples/08.suggested-actions/adapter_with_error_handler.py new file mode 100644 index 000000000..c41264829 --- /dev/null +++ b/samples/08.suggested-actions/adapter_with_error_handler.py @@ -0,0 +1,31 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +import sys +from botbuilder.core import ( + BotFrameworkAdapter, + BotFrameworkAdapterSettings, + MessageFactory, + TurnContext +) + + +class AdapterWithErrorHandler(BotFrameworkAdapter): + def __init__( + self, + settings: BotFrameworkAdapterSettings + ): + super().__init__(settings) + + # Catch-all for errors. + async def on_error(context: TurnContext, error: Exception): + # This check writes out errors to console log + # NOTE: In production environment, you should consider logging this to Azure + # application insights. + print(f"\n [on_turn_error]: {error}", file=sys.stderr) + + # Send a message to the user + error_message_text = "Sorry, it looks like something went wrong." + await context.send_activity(MessageFactory.text(error_message_text)) + + self.on_turn_error = on_error diff --git a/samples/08.suggested-actions/app.py b/samples/08.suggested-actions/app.py new file mode 100644 index 000000000..6376b703b --- /dev/null +++ b/samples/08.suggested-actions/app.py @@ -0,0 +1,58 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +""" +This sample shows a simple Bot that echos messages back to the user. +""" +import asyncio + +from flask import Flask, request, Response +from botbuilder.core import BotFrameworkAdapterSettings +from botbuilder.schema import Activity + +from bots import SuggestActionsBot +from adapter_with_error_handler import AdapterWithErrorHandler + +LOOP = asyncio.get_event_loop() +APP = Flask(__name__, instance_relative_config=True) +APP.config.from_object("config.DefaultConfig") + +SETTINGS = BotFrameworkAdapterSettings( + APP.config["APP_ID"], APP.config["APP_PASSWORD"] +) +ADAPTER = AdapterWithErrorHandler(SETTINGS) + +BOT = SuggestActionsBot() + + +@APP.route("/api/messages", methods=["POST"]) +def messages(): + """Main bot message handler.""" + if "application/json" in request.headers["Content-Type"]: + body = request.json + else: + return Response(status=415) + + activity = Activity().deserialize(body) + auth_header = ( + request.headers["Authorization"] if "Authorization" in request.headers else "" + ) + + async def aux_func(turn_context): + await BOT.on_turn(turn_context) + + try: + task = LOOP.create_task( + ADAPTER.process_activity(activity, auth_header, aux_func) + ) + LOOP.run_until_complete(task) + return Response(status=201) + except Exception as exception: + raise exception + + +if __name__ == "__main__": + try: + APP.run(debug=False, port=APP.config["PORT"]) # nosec debug + except Exception as exception: + raise exception diff --git a/samples/08.suggested-actions/bots/__init__.py b/samples/08.suggested-actions/bots/__init__.py new file mode 100644 index 000000000..cbf771a32 --- /dev/null +++ b/samples/08.suggested-actions/bots/__init__.py @@ -0,0 +1,6 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +from .suggested_actions_bot import SuggestActionsBot + +__all__ = ["SuggestActionsBot"] diff --git a/samples/08.suggested-actions/bots/suggested_actions_bot.py b/samples/08.suggested-actions/bots/suggested_actions_bot.py new file mode 100644 index 000000000..5bee547be --- /dev/null +++ b/samples/08.suggested-actions/bots/suggested_actions_bot.py @@ -0,0 +1,88 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +from botbuilder.core import ActivityHandler, MessageFactory, TurnContext +from botbuilder.schema import ChannelAccount, CardAction, ActionTypes, SuggestedActions + +""" +This bot will respond to the user's input with suggested actions. +Suggested actions enable your bot to present buttons that the user +can tap to provide input. +""" + + +class SuggestActionsBot(ActivityHandler): + async def on_members_added_activity(self, members_added: [ChannelAccount], turn_context: TurnContext): + """ + Send a welcome message to the user and tell them what actions they may perform to use this bot + """ + + return await self._send_welcome_message(turn_context) + + async def on_message_activity(self, turn_context: TurnContext): + """ + Respond to the users choice and display the suggested actions again. + """ + + text = turn_context.activity.text.lower() + response_text = self._process_input(text) + + await turn_context.send_activity(MessageFactory.text(response_text)) + + return await self._send_suggested_actions(turn_context) + + async def _send_welcome_message(self, turn_context: TurnContext): + for member in turn_context.activity.members_added: + if member.id != turn_context.activity.recipient.id: + await turn_context.send_activity(MessageFactory.text( + f"Welcome to SuggestedActionsBot {member.name}. This bot will introduce you to suggestedActions. " + f"Please answer the question: " + )) + + await self._send_suggested_actions(turn_context) + + def _process_input(self, text: str): + color_text = "is the best color, I agree." + + if text == "red": + return f"Red {color_text}" + + if text == "yellow": + return f"Yellow {color_text}" + + if text == "blue": + return f"Blue {color_text}" + + return "Please select a color from the suggested action choices" + + async def _send_suggested_actions(self, turn_context: TurnContext): + """ + Creates and sends an activity with suggested actions to the user. When the user + clicks one of the buttons the text value from the "CardAction" will be displayed + in the channel just as if the user entered the text. There are multiple + "ActionTypes" that may be used for different situations. + """ + + reply = MessageFactory.text("What is your favorite color?") + + reply.suggested_actions = SuggestedActions( + actions=[ + CardAction( + title="Red", + type=ActionTypes.im_back, + value="Read" + ), + CardAction( + title="Yellow", + type=ActionTypes.im_back, + value="Yellow" + ), + CardAction( + title="Blue", + type=ActionTypes.im_back, + value="Blue" + ) + ] + ) + + return await turn_context.send_activity(reply) diff --git a/samples/08.suggested-actions/config.py b/samples/08.suggested-actions/config.py new file mode 100644 index 000000000..c8c926f07 --- /dev/null +++ b/samples/08.suggested-actions/config.py @@ -0,0 +1,19 @@ +#!/usr/bin/env python3 +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +import os + +""" Bot Configuration """ + + +class DefaultConfig(object): + """ Bot Configuration """ + + PORT = 3978 + APP_ID = os.environ.get("MicrosoftAppId", "") + APP_PASSWORD = os.environ.get("MicrosoftAppPassword", "") + LUIS_APP_ID = os.environ.get("LuisAppId", "") + LUIS_API_KEY = os.environ.get("LuisAPIKey", "") + # LUIS endpoint host name, ie "westus.api.cognitive.microsoft.com" + LUIS_API_HOST_NAME = os.environ.get("LuisAPIHostName", "") diff --git a/samples/08.suggested-actions/requirements.txt b/samples/08.suggested-actions/requirements.txt new file mode 100644 index 000000000..7e54b62ec --- /dev/null +++ b/samples/08.suggested-actions/requirements.txt @@ -0,0 +1,2 @@ +botbuilder-core>=4.4.0b1 +flask>=1.0.3 From 5260474d26acca00aa06dcc33d75fd00448007ee Mon Sep 17 00:00:00 2001 From: Tracy Boehrer Date: Mon, 28 Oct 2019 16:33:49 -0500 Subject: [PATCH 2/4] Removed LUIS keys from settings. --- samples/08.suggested-actions/config.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/samples/08.suggested-actions/config.py b/samples/08.suggested-actions/config.py index c8c926f07..c46adb612 100644 --- a/samples/08.suggested-actions/config.py +++ b/samples/08.suggested-actions/config.py @@ -13,7 +13,3 @@ class DefaultConfig(object): PORT = 3978 APP_ID = os.environ.get("MicrosoftAppId", "") APP_PASSWORD = os.environ.get("MicrosoftAppPassword", "") - LUIS_APP_ID = os.environ.get("LuisAppId", "") - LUIS_API_KEY = os.environ.get("LuisAPIKey", "") - # LUIS endpoint host name, ie "westus.api.cognitive.microsoft.com" - LUIS_API_HOST_NAME = os.environ.get("LuisAPIHostName", "") From 3fe5e9f5a63a01c7218fd074cc74b2282b89b2eb Mon Sep 17 00:00:00 2001 From: Tracy Boehrer Date: Tue, 29 Oct 2019 08:41:52 -0500 Subject: [PATCH 3/4] Updated on_error messages, standardized app.py --- .../adapter_with_error_handler.py | 21 ++++++++++++++++--- samples/08.suggested-actions/app.py | 19 +++++++---------- samples/08.suggested-actions/config.py | 2 +- 3 files changed, 27 insertions(+), 15 deletions(-) diff --git a/samples/08.suggested-actions/adapter_with_error_handler.py b/samples/08.suggested-actions/adapter_with_error_handler.py index c41264829..cdce52540 100644 --- a/samples/08.suggested-actions/adapter_with_error_handler.py +++ b/samples/08.suggested-actions/adapter_with_error_handler.py @@ -2,12 +2,14 @@ # Licensed under the MIT License. import sys +from datetime import datetime + from botbuilder.core import ( BotFrameworkAdapter, BotFrameworkAdapterSettings, - MessageFactory, TurnContext ) +from botbuilder.schema import ActivityTypes, Activity class AdapterWithErrorHandler(BotFrameworkAdapter): @@ -25,7 +27,20 @@ async def on_error(context: TurnContext, error: Exception): print(f"\n [on_turn_error]: {error}", file=sys.stderr) # Send a message to the user - error_message_text = "Sorry, it looks like something went wrong." - await context.send_activity(MessageFactory.text(error_message_text)) + await context.send_activity("The bot encountered an error or bug.") + await context.send_activity("To continue to run this bot, please fix the bot source code.") + # Send a trace activity if we're talking to the Bot Framework Emulator + if context.activity.channel_id == 'emulator': + # Create a trace activity that contains the error object + trace_activity = Activity( + label="TurnError", + name="on_turn_error Trace", + timestamp=datetime.utcnow(), + type=ActivityTypes.trace, + value=f"{error}", + value_type="https://www.botframework.com/schemas/error" + ) + # Send a trace activity, which will be displayed in Bot Framework Emulator + await context.send_activity(trace_activity) self.on_turn_error = on_error diff --git a/samples/08.suggested-actions/app.py b/samples/08.suggested-actions/app.py index 6376b703b..64ebb15ca 100644 --- a/samples/08.suggested-actions/app.py +++ b/samples/08.suggested-actions/app.py @@ -1,9 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. -""" -This sample shows a simple Bot that echos messages back to the user. -""" import asyncio from flask import Flask, request, Response @@ -13,21 +10,24 @@ from bots import SuggestActionsBot from adapter_with_error_handler import AdapterWithErrorHandler +# Create the loop and Flask app LOOP = asyncio.get_event_loop() APP = Flask(__name__, instance_relative_config=True) APP.config.from_object("config.DefaultConfig") -SETTINGS = BotFrameworkAdapterSettings( - APP.config["APP_ID"], APP.config["APP_PASSWORD"] -) +# Create adapter. +# See https://aka.ms/about-bot-adapter to learn more about how bots work. +SETTINGS = BotFrameworkAdapterSettings(APP.config["APP_ID"], APP.config["APP_PASSWORD"]) ADAPTER = AdapterWithErrorHandler(SETTINGS) +# Create Bot BOT = SuggestActionsBot() +# Listen for incoming requests on /api/messages. @APP.route("/api/messages", methods=["POST"]) def messages(): - """Main bot message handler.""" + # Main bot message handler. if "application/json" in request.headers["Content-Type"]: body = request.json else: @@ -38,12 +38,9 @@ def messages(): request.headers["Authorization"] if "Authorization" in request.headers else "" ) - async def aux_func(turn_context): - await BOT.on_turn(turn_context) - try: task = LOOP.create_task( - ADAPTER.process_activity(activity, auth_header, aux_func) + ADAPTER.process_activity(activity, auth_header, BOT.on_turn) ) LOOP.run_until_complete(task) return Response(status=201) diff --git a/samples/08.suggested-actions/config.py b/samples/08.suggested-actions/config.py index c46adb612..e007d0fa9 100644 --- a/samples/08.suggested-actions/config.py +++ b/samples/08.suggested-actions/config.py @@ -7,7 +7,7 @@ """ Bot Configuration """ -class DefaultConfig(object): +class DefaultConfig: """ Bot Configuration """ PORT = 3978 From edc5ccff945ab617bd0e55dea14b55fd6dc90f7e Mon Sep 17 00:00:00 2001 From: Tracy Boehrer Date: Tue, 29 Oct 2019 12:48:55 -0500 Subject: [PATCH 4/4] Removed adapter_with_error_handler (migrated into app.py), corrected README. --- samples/08.suggested-actions/README.md | 12 ++--- .../adapter_with_error_handler.py | 46 ------------------- samples/08.suggested-actions/app.py | 37 +++++++++++++-- 3 files changed, 37 insertions(+), 58 deletions(-) delete mode 100644 samples/08.suggested-actions/adapter_with_error_handler.py diff --git a/samples/08.suggested-actions/README.md b/samples/08.suggested-actions/README.md index f476c6889..4e0e76ebb 100644 --- a/samples/08.suggested-actions/README.md +++ b/samples/08.suggested-actions/README.md @@ -9,14 +9,7 @@ This bot has been created using [Bot Framework](https://dev.botframework.com), i ```bash git clone https://github.com/Microsoft/botbuilder-python.git ``` -- Run `pip install -r requirements.txt` to install all dependencies -- Run `python app.py` -- Alternatively to the last command, you can set the file in an environment variable with `set FLASK_APP=app.py` in windows (`export FLASK_APP=app.py` in mac/linux) and then run `flask run --host=127.0.0.1 --port=3978` - -### Visual studio code -- Activate your desired virtual environment -- Open `botbuilder-python\samples\45.state-management` folder -- Bring up a terminal, navigate to `botbuilder-python\samples\02.echo-bot` folder +- Bring up a terminal, navigate to `botbuilder-python\samples\08.suggested-actions` folder - In the terminal, type `pip install -r requirements.txt` - In the terminal, type `python app.py` @@ -27,6 +20,9 @@ git clone https://github.com/Microsoft/botbuilder-python.git ### Connect to bot using Bot Framework Emulator - Launch Bot Framework Emulator +- File -> Open Bot - Paste this URL in the emulator window - http://localhost:3978/api/messages +## Suggested actions + Suggested actions enable your bot to present buttons that the user can tap to provide input. Suggested actions appear close to the composer and enhance user experience. diff --git a/samples/08.suggested-actions/adapter_with_error_handler.py b/samples/08.suggested-actions/adapter_with_error_handler.py deleted file mode 100644 index cdce52540..000000000 --- a/samples/08.suggested-actions/adapter_with_error_handler.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. - -import sys -from datetime import datetime - -from botbuilder.core import ( - BotFrameworkAdapter, - BotFrameworkAdapterSettings, - TurnContext -) -from botbuilder.schema import ActivityTypes, Activity - - -class AdapterWithErrorHandler(BotFrameworkAdapter): - def __init__( - self, - settings: BotFrameworkAdapterSettings - ): - super().__init__(settings) - - # Catch-all for errors. - async def on_error(context: TurnContext, error: Exception): - # This check writes out errors to console log - # NOTE: In production environment, you should consider logging this to Azure - # application insights. - print(f"\n [on_turn_error]: {error}", file=sys.stderr) - - # Send a message to the user - await context.send_activity("The bot encountered an error or bug.") - await context.send_activity("To continue to run this bot, please fix the bot source code.") - # Send a trace activity if we're talking to the Bot Framework Emulator - if context.activity.channel_id == 'emulator': - # Create a trace activity that contains the error object - trace_activity = Activity( - label="TurnError", - name="on_turn_error Trace", - timestamp=datetime.utcnow(), - type=ActivityTypes.trace, - value=f"{error}", - value_type="https://www.botframework.com/schemas/error" - ) - # Send a trace activity, which will be displayed in Bot Framework Emulator - await context.send_activity(trace_activity) - - self.on_turn_error = on_error diff --git a/samples/08.suggested-actions/app.py b/samples/08.suggested-actions/app.py index 64ebb15ca..4e9403486 100644 --- a/samples/08.suggested-actions/app.py +++ b/samples/08.suggested-actions/app.py @@ -2,13 +2,15 @@ # Licensed under the MIT License. import asyncio +import sys +from datetime import datetime +from types import MethodType from flask import Flask, request, Response -from botbuilder.core import BotFrameworkAdapterSettings -from botbuilder.schema import Activity +from botbuilder.core import BotFrameworkAdapterSettings, BotFrameworkAdapter, TurnContext +from botbuilder.schema import Activity, ActivityTypes from bots import SuggestActionsBot -from adapter_with_error_handler import AdapterWithErrorHandler # Create the loop and Flask app LOOP = asyncio.get_event_loop() @@ -18,7 +20,34 @@ # Create adapter. # See https://aka.ms/about-bot-adapter to learn more about how bots work. SETTINGS = BotFrameworkAdapterSettings(APP.config["APP_ID"], APP.config["APP_PASSWORD"]) -ADAPTER = AdapterWithErrorHandler(SETTINGS) +ADAPTER = BotFrameworkAdapter(SETTINGS) + + +# Catch-all for errors. +async def on_error(self, context: TurnContext, error: Exception): + # This check writes out errors to console log .vs. app insights. + # NOTE: In production environment, you should consider logging this to Azure + # application insights. + print(f"\n [on_turn_error] unhandled error: {error}", file=sys.stderr) + + # Send a message to the user + await context.send_activity("The bot encountered an error or bug.") + await context.send_activity("To continue to run this bot, please fix the bot source code.") + # Send a trace activity if we're talking to the Bot Framework Emulator + if context.activity.channel_id == 'emulator': + # Create a trace activity that contains the error object + trace_activity = Activity( + label="TurnError", + name="on_turn_error Trace", + timestamp=datetime.utcnow(), + type=ActivityTypes.trace, + value=f"{error}", + value_type="https://www.botframework.com/schemas/error" + ) + # Send a trace activity, which will be displayed in Bot Framework Emulator + await context.send_activity(trace_activity) + +ADAPTER.on_turn_error = MethodType(on_error, ADAPTER) # Create Bot BOT = SuggestActionsBot()