[IC3 ACS Chat ] API Review

[azure-sdk]

New API Review meeting has been requested.

Service Name: IC3 ACS Chat
Review Created By: Cheuk Chuen Siow
Review Date: 01/14/2025 01:00 PM PT
Release Plan:
PR: #31243
Hero Scenarios Link: Not Provided
Core Concepts Doc Link: Not Provided

Description: ACS Chat faces several concerns regarding the existing bot channel implementation:

• Only partial support to a subset of bot activities
• Certain properties of supported bot activities are being discarded during transit
• Inability to enrich messages for bots to consume
• Unable to propagate thread and participant metadata to bots

The way we currently implement bot channel integration is not ideal. We're reserving a space in chat message metadata that is meant to be reserved for Contoso's usage, and having json string payload in the message content.

We're introducing new message types (AzureBotActivity and AzureBotCommand) in ChatMessageType enum, enabling ACS Chat to act as transport layer so that the entire bot payload can be sent and received by Azure bots in the form of bot activity.

Detailed meeting information and documents provided can be accessed here
For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

[mikekistler]

Azure Versioning policy requires any change to service behavior / API surface be done in a new API version. Please make the proposed changes in a new API version or explain why this is not possible / practical.

[azure-sdk]

New API Review meeting has been requested.

Service Name: IC3 ACS Chat
Review Created By: Cheuk Chuen Siow
Review Date: 01/28/2025 01:00 PM PT
Release Plan:
PR: #31243
Hero Scenarios Link: Not Provided
Core Concepts Doc Link: Not Provided

Description: ACS Chat faces several concerns regarding the existing bot channel implementation:

• Only partial support to a subset of bot activities
• Certain properties of supported bot activities are being discarded during transit
• Inability to enrich messages for bots to consume
• Unable to propagate thread and participant metadata to bots

The way we currently implement bot channel integration is not ideal. We're reserving a space in chat message metadata that is meant to be reserved for Contoso's usage, and having json string payload in the message content.

We're introducing new message types (AzureBotActivity and AzureBotCommand) in ChatMessageType enum, enabling ACS Chat to act as transport layer so that the entire bot payload can be sent and received by Azure bots in the form of bot activity.

Detailed meeting information and documents provided can be accessed here
For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

[mikekistler]

Notes from API Review 1/14/25

• Need to go to breaking change office hours for review/approval of breaking changes
• Why allow clients to send Bot messages? Should not allow that unless there are solid customer requirements for it.
• What happens if a passthrough message is changed to be handled natively? Would that break customers already handling the message as passthrough?
  • Maybe in this case it becomes two events ?

This mostly looks fine except for concerns about potential to break customers, both in the reformat of the channel data contents and how transitions from passthrough to native are handled. We need to dive deeper on these to make sure we have the best approach.

[azure-sdk]

Meeting updated by Cheuk Chuen Siow

Service Name: IC3 ACS Chat
Review Created By: Cheuk Chuen Siow
Review Date: 01/28/2025 01:00 PM PT
Release Plan:
PR: #32333
Hero Scenarios Link: Not Provided
Core Concepts Doc Link: Not Provided

Description: ACS Chat faces several concerns regarding the existing bot channel implementation:

• Only partial support to a subset of bot activities
• Certain properties of supported bot activities are being discarded during transit
• Inability to enrich messages for bots to consume
• Unable to propagate thread and participant metadata to bots

The way we currently implement bot channel integration is not ideal. We're reserving a space in chat message metadata that is meant to be reserved for Contoso's usage, and having json string payload in the message content.

We're introducing new message types (AzureBotActivity and AzureBotCommand) in ChatMessageType enum, enabling ACS Chat to act as transport layer so that the entire bot payload can be sent and received by Azure bots in the form of bot activity.

Detailed meeting information and documents provided can be accessed here
For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

[cheukchuen]

Azure Versioning policy requires any change to service behavior / API surface be done in a new API version. Please make the proposed changes in a new API version or explain why this is not possible / practical.

Created a new API preview version to introduce a change in the API spec: #32333