Skip to content

Commit 467033d

Browse files
DanielabomDanielabom
authored
Merge pull request #25916 from microsoftgraph/user/edle/CopilotChangeNotificationDocs
Copilot change notifications
2 parents 63d0247 + 71c6a93 commit 467033d

19 files changed

+409
-6
lines changed

‎api-reference/beta/api/subscription-delete.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Depending on the resource and the permission type (delegated or application) req
2929
3030
| Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application |
3131
|:-----|:-----|:-----|:-----|
32+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/users/{userId}/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions that a particular user is part of. | AiEnterpriseInteraction.Read | Not supported. | AiEnterpriseInteraction.Read.All, AiEnterpriseInteraction.Read.User |
33+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions in an organization. | Not supported. | Not supported. | AiEnterpriseInteraction.Read.All |
3234
|[approvalItems](../resources/approvalItem.md) | Not supported. | Not supported. | ApprovalSolution.ReadWrite.All |
3335
|[callRecord](../resources/callrecords-callrecord.md) | Not supported. | Not supported. | CallRecords.Read.All |
3436
|[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All |
@@ -92,9 +94,13 @@ Depending on the resource and the permission type (delegated or application) req
9294
> - Chat.Manage.Chat
9395
> - ChannelMessage.Read.Group
9496
> - ChatMember.Read.Chat
97+
> - AiEnterpriseInteraction.Read.User
9598
9699
[!INCLUDE [teams-subscription-notes](../../includes/teams-subscription-notes.md)]
97100

101+
<!-- ### aiInteraction -->
102+
[!INCLUDE [copilot-aiinteraction-subscription-notes.md](../../includes/copilot-aiinteraction-subscription-notes.md)]
103+
98104
### driveItem
99105

100106
More limitations apply to subscriptions on OneDrive items. The limitations apply to creating as well as managing (getting, updating, and deleting) subscriptions.

‎api-reference/beta/api/subscription-get.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Depending on the resource and the permission type (delegated or application) req
2929
3030
| Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application |
3131
|:-----|:-----|:-----|:-----|
32+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/users/{userId}/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions that a particular user is part of. | AiEnterpriseInteraction.Read | Not supported. | AiEnterpriseInteraction.Read.All, AiEnterpriseInteraction.Read.User |
33+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions in an organization. | Not supported. | Not supported. | AiEnterpriseInteraction.Read.All |
3234
|[approvalItems](../resources/approvalItem.md) | Not supported. | Not supported. | ApprovalSolution.ReadWrite.All |
3335
|[callRecord](../resources/callrecords-callrecord.md) | Not supported. | Not supported. | CallRecords.Read.All |
3436
|[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All |
@@ -92,9 +94,13 @@ Depending on the resource and the permission type (delegated or application) req
9294
> - Chat.Manage.Chat
9395
> - ChannelMessage.Read.Group
9496
> - ChatMember.Read.Chat
97+
> - AiEnterpriseInteraction.Read.User
9598
9699
[!INCLUDE [teams-subscription-notes](../../includes/teams-subscription-notes.md)]
97100

101+
<!-- ### aiInteraction -->
102+
[!INCLUDE [copilot-aiinteraction-subscription-notes.md](../../includes/copilot-aiinteraction-subscription-notes.md)]
103+
98104
### driveItem
99105

100106
More limitations apply to subscriptions on OneDrive items. The limitations apply to creating as well as managing (getting, updating, and deleting) subscriptions.

‎api-reference/beta/api/subscription-list.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Depending on the resource and the permission type (delegated or application) req
2929
3030
| Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application |
3131
|:-----|:-----|:-----|:-----|
32+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/users/{userId}/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions that a particular user is part of. | AiEnterpriseInteraction.Read | Not supported. | AiEnterpriseInteraction.Read.All, AiEnterpriseInteraction.Read.User |
33+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions in an organization. | Not supported. | Not supported. | AiEnterpriseInteraction.Read.All |
3234
|[approvalItems](../resources/approvalItem.md) | Not supported. | Not supported. | ApprovalSolution.ReadWrite.All |
3335
|[callRecord](../resources/callrecords-callrecord.md) | Not supported. | Not supported. | CallRecords.Read.All |
3436
|[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All |
@@ -91,9 +93,13 @@ Depending on the resource and the permission type (delegated or application) req
9193
> - Chat.Manage.Chat
9294
> - ChannelMessage.Read.Group
9395
> - ChatMember.Read.Chat
96+
> - AiEnterpriseInteraction.Read.User
9497
9598
Response results are based on the context of the calling app. The following sections describe the common scenarios.
9699

100+
<!-- ### aiInteraction -->
101+
[!INCLUDE [copilot-aiinteraction-subscription-notes.md](../../includes/copilot-aiinteraction-subscription-notes.md)]
102+
97103
### Basic scenarios
98104

99105
Most commonly, an application wants to retrieve subscriptions that it originally created for the currently signed-in user or all users in the directory (work/school accounts). These scenarios don't require any special permissions beyond the ones the app used originally to create its subscriptions.

‎api-reference/beta/api/subscription-post-subscriptions.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Depending on the resource and the permission type (delegated or application) req
3434
3535
| Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application |
3636
|:-----|:-----|:-----|:-----|
37+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/users/{userId}/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions that a particular user is part of. | AiEnterpriseInteraction.Read | Not supported. | AiEnterpriseInteraction.Read.All, AiEnterpriseInteraction.Read.User |
38+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions in an organization. | Not supported. | Not supported. | AiEnterpriseInteraction.Read.All |
3739
|[approvalItems](../resources/approvalItem.md) | Not supported. | Not supported. | ApprovalSolution.ReadWrite.All |
3840
|[callRecord](../resources/callrecords-callrecord.md) | Not supported. | Not supported. | CallRecords.Read.All |
3941
|[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All |
@@ -97,9 +99,13 @@ Depending on the resource and the permission type (delegated or application) req
9799
> - Chat.Manage.Chat
98100
> - ChannelMessage.Read.Group
99101
> - ChatMember.Read.Chat
102+
> - AiEnterpriseInteraction.Read.User
100103
101104
[!INCLUDE [teams-subscription-notes](../../includes/teams-subscription-notes.md)]
102105

106+
<!-- ### aiInteraction -->
107+
[!INCLUDE [copilot-aiinteraction-subscription-notes.md](../../includes/copilot-aiinteraction-subscription-notes.md)]
108+
103109
### driveItem
104110

105111
More limitations apply to subscriptions on OneDrive items. The limitations apply to creating as well as managing (getting, updating, and deleting) subscriptions.
@@ -123,7 +129,6 @@ For details about online meeting subscriptions, see [Get change notifications fo
123129

124130
Subscriptions on virtual events support only basic notifications and are limited to a few entities of a virtual event. For more information about the supported subscription types, see [Get change notifications for Microsoft Teams virtual event updates](/graph/changenotifications-for-virtualevent).
125131

126-
127132
## HTTP request
128133

129134
<!-- { "blockType": "ignored" } -->

‎api-reference/beta/api/subscription-reauthorize.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Depending on the resource and the permission type (delegated or application) req
2626
2727
| Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application |
2828
|:-----|:-----|:-----|:-----|
29+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/users/{userId}/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions that a particular user is part of. | AiEnterpriseInteraction.Read | Not supported. | AiEnterpriseInteraction.Read.All, AiEnterpriseInteraction.Read.User |
30+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions in an organization. | Not supported. | Not supported. | AiEnterpriseInteraction.Read.All |
2931
|[approvals](../resources/approvalitem.md) | Not supported. | Not supported. | ApprovalSolution.ReadWrite.All |
3032
|[callRecord](../resources/callrecords-callrecord.md) | Not supported. | Not supported. | CallRecords.Read.All |
3133
|[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All |
@@ -88,9 +90,13 @@ Depending on the resource and the permission type (delegated or application) req
8890
> - Chat.Manage.Chat
8991
> - ChannelMessage.Read.Group
9092
> - ChatMember.Read.Chat
93+
> - AiEnterpriseInteraction.Read.User
9194
9295
[!INCLUDE [teams-subscription-notes](../../includes/teams-subscription-notes.md)]
9396

97+
<!-- ### aiInteraction -->
98+
[!INCLUDE [copilot-aiinteraction-subscription-notes.md](../../includes/copilot-aiinteraction-subscription-notes.md)]
99+
94100
## HTTP request
95101

96102
<!-- {

‎api-reference/beta/api/subscription-update.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Depending on the resource and the permission type (delegated or application) req
3131
3232
| Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application |
3333
|:-----|:-----|:-----|:-----|
34+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/users/{userId}/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions that a particular user is part of. | AiEnterpriseInteraction.Read | Not supported. | AiEnterpriseInteraction.Read.All, AiEnterpriseInteraction.Read.User |
35+
|[aiInteraction](../resources/aiinteraction.md) <br /> `copilot/interactionHistory/getAllEnterpriseInteractions` <br /> Copilot AI interactions in an organization. | Not supported. | Not supported. | AiEnterpriseInteraction.Read.All |
3436
|[approvalItems](../resources/approvalItem.md) | Not supported. | Not supported. | ApprovalSolution.ReadWrite.All |
3537
|[callRecord](../resources/callrecords-callrecord.md) | Not supported. | Not supported. | CallRecords.Read.All |
3638
|[callRecording](../resources/callrecording.md) <br /> `communications/onlineMeetings/getAllRecordings` <br /> Any recording becomes available in the tenant. | Not supported. | Not supported. | OnlineMeetingRecording.Read.All |
@@ -94,9 +96,13 @@ Depending on the resource and the permission type (delegated or application) req
9496
> - Chat.Manage.Chat
9597
> - ChannelMessage.Read.Group
9698
> - ChatMember.Read.Chat
99+
> - AiEnterpriseInteraction.Read.User
97100
98101
[!INCLUDE [teams-subscription-notes](../../includes/teams-subscription-notes.md)]
99102

103+
<!-- ### aiInteraction -->
104+
[!INCLUDE [copilot-aiinteraction-subscription-notes.md](../../includes/copilot-aiinteraction-subscription-notes.md)]
105+
100106
### driveItem
101107

102108
More limitations apply to subscriptions on OneDrive items. The limitations apply to creating as well as managing (getting, updating, and deleting) subscriptions.

‎api-reference/beta/resources/aiinteractionhistory.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,7 @@ Represents a list of messages exchanged involving AI.
2727
None.
2828

2929
## Relationships
30-
| Relationship | Type | Description |
31-
|:--------------|:---------|:------------|
32-
| interactions | [aiInteraction](../resources/aiinteraction.md) collection| The list of AI interactions. |
33-
30+
None.
3431

3532
## JSON representation
3633

@@ -46,6 +43,6 @@ The following JSON representation shows the resource type.
4643

4744
```json
4845
{
49-
"interactions": [{"@odata.type": "microsoft.graph.aiinteraction"}]
46+
"@odata.type": "#microsoft.graph.aiInteractionHistory"
5047
}
5148
```

‎api-reference/beta/resources/copilotroot.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ None.
2424
|Relationship|Type|Description|
2525
|:---|:---|:---|
2626
|admin|[copilotAdmin](../resources/copilotadmin.md)|The Microsoft 365 Copilot admin who can add or modify Copilot settings. Read-only. Nullable.|
27+
|interactionHistory|[aiInteractionHistory](../resources/aiinteractionhistory.md)|The history of interactions between AI agents and users.|
2728

2829
## JSON representation
2930
The following JSON representation shows the resource type.

‎api-reference/includes/copilot-aiinteraction-subscription-notes.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
author: "edle"
3+
ms.topic: include
4+
ms.date: 12/11/2024
5+
ms.localizationpriority: medium
6+
---
7+
8+
<!-- markdownlint-disable MD041-->
9+
10+
### aiInteraction
11+
12+
Subscriptions on Copilot AI interactions require a valid Copilot license that includes the following Copilot service plans:
13+
14+
* **Microsoft Graph connectors in Microsoft 365 Copilot**: 82d30987-df9b-4486-b146-198b21d164c7
15+
* **Intelligent search**: 931e4a88-a67f-48b5-814f-16a5f1e6028d
16+
* **Microsoft 365 Copilot in Microsoft Teams**: b95945de-b3bd-46db-8437-f2beb6ea2347
17+
* **Microsoft 365 Copilot in productivity apps**: a62f8878-de10-42f3-b68f-6149a25ceb97
18+
* **Microsoft 365 Copilot Chat**: 3f30311c-6b1e-48a4-ab79-725b469da960
19+
* **Power Platform connectors in Microsoft 365 Copilot**: 89f1c4c8-0878-40f7-804d-869c9128ab5d
20+
21+
For subscriptions that target Copilot AI interactions that a particular user is part of, the user in the resource path must have the previous service plans assigned to them in a valid state.
22+
23+
For subscriptions that target Copilot AI interactions for the entire tenant, the tenant must have valid licenses provisioned that include all previous Copilot service plans.

‎changelog/Microsoft.SubscriptionServices.json

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -639,6 +639,56 @@
639639
"CreatedDateTime": "2025-01-06T00:00:00",
640640
"WorkloadArea": "Change notifications",
641641
"SubArea": ""
642+
},
643+
{
644+
"ChangeList": [
645+
{
646+
"Id": "08b12c1b-76b9-40a9-8124-5c8ec4bb035c",
647+
"ApiChange": "Method",
648+
"ChangedApiName": "DELETE",
649+
"ChangeType": "Addition",
650+
"Description": "Enabled change notifications support to the method to [delete](https://learn.microsoft.com/en-us/graph/api/subscription-delete?view=graph-rest-beta) a subscription for [aiInteraction](https://learn.microsoft.com/en-us/graph/api/resources/aiinteraction?view=graph-rest-beta).",
651+
"Target": "subscription"
652+
},
653+
{
654+
"Id": "08b12c1b-76b9-40a9-8124-5c8ec4bb035c",
655+
"ApiChange": "Method",
656+
"ChangedApiName": "PATCH",
657+
"ChangeType": "Addition",
658+
"Description": "Enabled change notifications support to the method to [update](https://learn.microsoft.com/en-us/graph/api/subscription-update?view=graph-rest-beta) a subscription for [aiInteraction](https://learn.microsoft.com/en-us/graph/api/resources/aiinteraction?view=graph-rest-beta).",
659+
"Target": "subscription"
660+
},
661+
{
662+
"Id": "08b12c1b-76b9-40a9-8124-5c8ec4bb035c",
663+
"ApiChange": "Method",
664+
"ChangedApiName": "GET",
665+
"ChangeType": "Addition",
666+
"Description": "Enabled change notifications support to the methods to [get](https://learn.microsoft.com/en-us/graph/api/subscription-get?view=graph-rest-beta) and [list](https://learn.microsoft.com/en-us/graph/api/subscription-list?view=graph-rest-beta) a subscription for [aiInteraction](https://learn.microsoft.com/en-us/graph/api/resources/aiinteraction?view=graph-rest-beta).",
667+
"Target": "subscription"
668+
},
669+
{
670+
"Id": "08b12c1b-76b9-40a9-8124-5c8ec4bb035c",
671+
"ApiChange": "Method",
672+
"ChangedApiName": "POST",
673+
"ChangeType": "Addition",
674+
"Description": "Enabled change notifications support to the method to [create](https://learn.microsoft.com/en-us/graph/api/subscription-post-subscriptions?view=graph-rest-beta) a subscription for [aiInteraction](https://learn.microsoft.com/en-us/graph/api/resources/aiinteraction?view=graph-rest-beta).",
675+
"Target": "subscription"
676+
},
677+
{
678+
"Id": "08b12c1b-76b9-40a9-8124-5c8ec4bb035c",
679+
"ApiChange": "Method",
680+
"ChangedApiName": "reauthorize",
681+
"ChangeType": "Addition",
682+
"Description": "Enabled change notifications support to the method to [reauthorize](https://learn.microsoft.com/en-us/graph/api/subscription-reauthorize?view=graph-rest-beta) a subscription for [aiInteraction](https://learn.microsoft.com/en-us/graph/api/resources/aiinteraction?view=graph-rest-beta).",
683+
"Target": "subscription"
684+
}
685+
],
686+
"Id": "08b12c1b-76b9-40a9-8124-5c8ec4bb035c",
687+
"Cloud": "Prod",
688+
"Version": "beta",
689+
"CreatedDateTime": "2025-01-30T00:00:00",
690+
"WorkloadArea": "Change notifications",
691+
"SubArea": ""
642692
}
643693
]
644694
}

0 commit comments

Comments
 (0)