[Bug] on_turn_error: unhandled error: 'text'

[frankqianms]

Github issues should be used for bugs and feature requests. Use Stack Overflow for general "how-to" questions.

Version

latest

Describe the bug

Using botbuilder-python and teams-ai SDK to build a Teams bot with AI response. When sideloading the bot in the M365 Copilot, on_turn_error will occur if trying to conversation with the bot.
Linked issue: microsoft/teams-ai#2326

To Reproduce

repro-noresponse-in-copilot.mp4

[on_turn_error] unhandled error: 'text'
Traceback (most recent call last):
  File "c:\Users\frankqian\TeamsApps\test11\.venv\Lib\site-packages\botbuilder\core\bot_adapter.py", line 174, in run_pipeline
    return await self._middleware.receive_activity_with_status(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "c:\Users\frankqian\TeamsApps\test11\.venv\Lib\site-packages\botbuilder\core\middleware_set.py", line 69, in receive_activity_with_status
    return await self.receive_activity_internal(context, callback)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "c:\Users\frankqian\TeamsApps\test11\.venv\Lib\site-packages\botbuilder\core\middleware_set.py", line 79, in receive_activity_internal
    return await callback(context)
           ^^^^^^^^^^^^^^^^^^^^^^^
  File "c:\Users\frankqian\TeamsApps\test11\.venv\Lib\site-packages\teams\app.py", line 745, in on_turn
    await self._start_long_running_call(context, self._on_turn)
  File "c:\Users\frankqian\TeamsApps\test11\.venv\Lib\site-packages\teams\app.py", line 903, in _start_long_running_call
    return await func(context)
           ^^^^^^^^^^^^^^^^^^^
  File "c:\Users\frankqian\TeamsApps\test11\.venv\Lib\site-packages\teams\app.py", line 751, in _on_turn
    self._remove_mentions(context)
  File "c:\Users\frankqian\TeamsApps\test11\.venv\Lib\site-packages\teams\app.py", line 786, in _remove_mentions
    context.activity.text = context.remove_recipient_mention(context.activity)
                            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "c:\Users\frankqian\TeamsApps\test11\.venv\Lib\site-packages\botbuilder\core\turn_context.py", line 392, in remove_recipient_mention
    return TurnContext.remove_mention_text(activity, activity.recipient.id)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "c:\Users\frankqian\TeamsApps\test11\.venv\Lib\site-packages\botbuilder\core\turn_context.py", line 401, in remove_mention_text
    escape(mention.additional_properties["text"]),
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^
KeyError: 'text'

Expected behavior

Give a clear and concise description of what you expected to happen.

Screenshots

If applicable, add screenshots to help explain your problem.

Additional context

Add any other context about the problem here.

[tracyboehrer]

@frankqianms This appears to be in relation to Teams AI SDK and should be directed to the repo. If I could, I would transfer the issue. But that isn't possible since that is a different group.

[iMicknl]

The problematic code is in:

botbuilder-python/libraries/botbuilder-core/botbuilder/core/turn_context.py

Line 401 in bd5662a

escape(mention.additional_properties["text"]),

This is not related to teams-ai library.

[tracyboehrer]

Looks like a bug. We can take a look at that.

[iMicknl]

This is how an incoming activity from M365 Copilot (custom engine agent) looks like, which is not compatible with the current code mentioned above.

{
    "text": "Hallo",
    "textFormat": "plain",
    "type": "message",
    "timestamp": "2025-03-11T14:16:47.0093935Z",
    "id": "1741702606984",
    "channelId": "msteams",
    "serviceUrl": "https://smba.trafficmanager.net/emea/REDACTED/",
    "from": {
        "id": "29:1J-K4xVh-sLpdwQ-R5GkOZ_TB0W3ec_37p710aH8qe8bITA0zxdgIGc9l-MdDdkdE_jasSfNOeWXyyL1nsrHtBQ",
        "name": "",
        "aadObjectId": "REDACTED"
    },
    "conversation": {
        "isGroup": true,
        "conversationType": "groupChat",
        "tenantId": "REDACTED",
        "id": "19:[email protected]"
    },
    "recipient": {
        "id": "28:c5d5fb56-a1a4-4467-a7a3-1b37905498a0",
        "name": "Azure AI Agent"
    },
    "entities": [
        {
            "mentioned": {
                "id": "28:c5d5fb56-a1a4-4467-a7a3-1b37905498a0",
                "name": "Custom Agent"
            },
            "type": "mention"
        }
    ],
    "channelData": {
        "tenant": {
            "id": "REDACTED"
        },
        "productContext": "COPILOT"
    }
}

[tracyboehrer]

Ya. The mention doesn't have a Text property and that is what it's trying to work with. But that is a very helpful payload to work with. Probably don't even need to run it through a bot.