Buttons click handling MS Botframework

[thaume]

Rasa version: 2.3.0

Rasa SDK version (if used & relevant): Nope

Rasa X version (if used & relevant): Nope

Python version: I'm using the provided dockerfile to build and run Rasa

Operating system (windows, osx, ...): MacOS, but again rasa is running in Docker

Issue:

I'm having an issue with handling buttons clicks coming from Teams. The way Teams handles clicks and text input is different and right now the Botframework Rasa connector (that was built by my company 2 years ago) doesn't support that.

We have a working version that we keep up to date with the master repo from time to time but I think it would make more sense to take the time to merge it.

And... it's just 6 lines of code

😅

Error (including full traceback): This is the stacktrace shown by Rasa after a click on a button

2021-03-10 09:47:44 DEBUG rasa.core.processor - Received user message '' with intent '

{'name': None, 'confidence': 0.0}

' and entities '[]'

Command or request that led to error: After writing and sending a message ("Home") to Rasa from Teams, this JSON is sent to rasa endpoint :

{
 "text": "Home",
 "textFormat": "plain",
 "type": "message",
 "timestamp": "
 ",
 "localTimestamp": "

 ",
 "id": "

 ",
 "channelId": "msteams",
 "serviceUrl": "https://smba.trafficmanager.net/emea/",
 "from": 

 { "id": " ", "name": " ", "aadObjectId": " " } 

, "conversation": 

 { "conversationType": "personal", "tenantId": " ", "id": " " } 

, "recipient": 

 { "id": " ", "name": " " } 

, "entities": [ 

 { "locale": "en-GB", "country": "GB", "platform": "Web", "timezone": "Europe/Paris", "type": "clientInfo" } 

 ], "channelData": { "tenant": 

 { "id": " " } 

 }, "locale": "en-GB", "localTimezone": "Europe/Paris" }

 

After clicking on a button from a card (created by the chatbot) on Teams, this JSON is sent to rasa endpoint :

{
 "type": "message",
 "timestamp": "
 ",
 "localTimestamp": "

 ",
 "id": "

 ",
 "channelId": "msteams",
 "serviceUrl": "https://smba.trafficmanager.net/emea/",
 "from": 

 { "id": " ", "name": " ", "aadObjectId": " " } 

, "conversation": 

 { "conversationType": "personal", "tenantId": " ", "id": " " } 

, "recipient": 

 { "id": " ", "name": " " } 

, "entities": [ 

 { "locale": "en-GB", "country": "GB", "platform": "Web", "timezone": "Europe/Paris", "type": "clientInfo" } 

 ], "channelData": { "tenant": 

 { "id": " " } 

, "source": 

 { "name": "message" } 

, "legacy": 

 { "replyToId": " " } 

 }, "replyToId": "

 ", "value": 

 { "id": "Jobs" } 

, "locale": "en-GB", "localTimezone": "Europe/Paris" }

 

As you can see, the text key is present only when sending data as text but not when clicking on a button (the button's data is inside a value dict).

Right now this data is handled here : https://github.com/RasaHQ/rasa/blob/main/rasa/core/channels/botframework.py#L236

And we are handling it like that on our repo :

text = ""
 if postdata.get("text"):
 text = postdata.get("text")
 else:
 if postdata.get("value"):
 raw_value = postdata.get("value")
 if "value" in raw_value:
 raw_value = raw_value["value"]
 text = json.dumps(raw_value)

 user_msg = UserMessage(
 text=text,
 output_channel=out_channel,
 sender_id=postdata["from"]["id"],
 input_channel=self.name(),
 metadata=metadata_with_attachments,
 )

How would you like to solve this problem ?

Thanks !

Content of configuration file (config.yml) (if relevant): not modified

Content of domain file (domain.yml) (if relevant): not modified

[sara-tagger]

Exalate commented:

sara-tagger commented:

Thanks for raising this issue, @m-vdb will get back to you about it soon

✨

Please also check out the docs and the forum in case your issue was raised there too

🤗

[m-vdb]

Exalate commented:

m-vdb commented:

Hi @thaume and thanks for creating this GitHub issue. Would you be up for submitting a pull request? We'll gladly review it

[thaume]

Exalate commented:

thaume commented:

Hi @m-vdb sure ! I just wanted to double check with you first that this was of interest and made sense for the project

[m-vdb]

Exalate commented:

m-vdb commented:

yeah I think it'd be useful! I don't know much about this channel, but if this use case is not working for you, it's possible it's not working for other people. Would be great if in your PR you could link to the API reference, I think it'd be easier for other contributors

[thaume]

Exalate commented:

thaume commented:

Hey @m-vdb, the PR is over here #8190 ! Let me know what you think

[stale]

Exalate commented:

stale[bot] commented:

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[guilhermemoraisr]

Hey! Is this issue still open for contribution? I would like to help solve it

[m-vdb]

yes it it 🎉 Another contributor had submitted a PR a while ago, but it's currently stale. Feel free to take a look at the code they wrote (and the review comments that were shared) :)

[thaume]

Hey everyone,

Just FYI @guilhermemoraisr, only tests are missing. It's very possible the code doesn't work with the latest version of MS Botframework tho

The project I was working on for bot framework was finished about a year ago so I don't use it anymore but happy to help if you have questions!

[sync-by-unito]

➤ Maxime Verger commented:

💡 Heads up! We're moving issues to Jira: https://rasa-open-source.atlassian.net/browse/OSS.

From now on, this Jira board is the place where you can browse (without an account) and create issues (you'll need a free Jira account for that). This GitHub issue has already been migrated to Jira and will be closed on January 9th, 2023. Do not forget to subscribe to the corresponding Jira issue!

➡️ More information in the forum: https://forum.rasa.com/t/migration-of-rasa-oss-issues-to-jira/56569.