Introduce ProductInfo Node to entities to identify the internal channel / product of a channelID

Open
#77 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale

Research direction

Start by locating the Activity Protocol entity definitions and current channelId handling. Compare the proposed ProductInfo entity and subChannelInfo example with the existing protocol structure, then confirm the schema, serialization, and test or example coverage needed for the new product identifier.

Written by the indexing model from the issue text.

Description

Spec change accepted Specs

Within the concept of Clients/Channel providers there are some providers that group a set of channels behind a single "public" channel.
There are currently two examples of this inside the MSFT ecosystem.

  • Azure Communications Services
  • M365 msTeams Channel

In these cases, multiple clients are fronted by a single service,

Currently, the Activity Protocol described a single channel concept called "channel Id".
To handle the updated requirements, we would introduce a new component in entitles called "ProductInfo".
ProductInfo wil contain an ID used to identity if the 'subproduct' behind the channelid and any additional information about the channel client that is available.

This would take the shape of:

            "subChannelInfo": {
                "channelId": "COPILOT"
            }

as it would appear in the existing in the structure:

{
    "id": "1741193418370",
    "channelId": "msteams",
    "entities": [
        {
                "type" : "ProductInfo"
                "id": "COPILOT"
// Intent to expand at a later date with additional properties.
            }
        }
    ],
    "channelData": {
        "tenant": {
            "id": "000000-0000-0000-00000-00000000000"
        },
        "productContext": "COPILOT"
    }
}
Dominant language
TypeSpec
Stars
1.1k
Forks
340
Avg merge
3d 13h
Merged PRs (30d)
12

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/Agents

All issues in microsoft/Agents

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.