Skip to content

Commit 9bc0e75

Browse files
LauragraLauragra
authored
Merge pull request #25705 from microsoftgraph/users/bkeerthivasa/addCopilotExportApi
Add aiInteraction : getAllEnterpriseInteractions graph doc
2 parents 6a168dc + 157fbb0 commit 9bc0e75

16 files changed

+879
-0
lines changed

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

Lines changed: 303 additions & 0 deletions
Large diffs are not rendered by default.

‎api-reference/beta/includes/permissions/aiinteractionhistory-getallenterpriseinteractions-permissions.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|Not supported.|Not supported.|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|AiEnterpriseInteraction.Read.All|Not available.|
12+

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

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: "aiInteraction resource type"
3+
description: "Represents an interaction between a user and Copilot."
4+
ms.date: 11/18/2024
5+
doc_type: resourcePageType
6+
ms.localizationpriority: medium
7+
author: "bkeerthivasa"
8+
ms.subservice: "teams"
9+
toc.title: "AI interaction"
10+
---
11+
12+
# aiInteraction resource type
13+
14+
Namespace: microsoft.graph
15+
16+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
17+
18+
Represents an interaction between a user and Copilot.
19+
20+
## Methods
21+
22+
None.
23+
24+
## Properties
25+
26+
| Property | Type | Description |
27+
|:---------------|:--------|:----------|
28+
| appClass | String | The data source for Copilot data. For example, `IPM.SkypeTeams.Message.Copilot.Excel` or `IPM.SkypeTeams.Message.Copilot.Loop`. |
29+
| attachments | [aiInteractionAttachment](../resources/aiinteractionattachment.md) collection | The collection of documents attached to the interaction, such as cards and images. |
30+
| body | [itemBody](../resources/itembody.md) | The body of the message, including the text of the body and its body type. |
31+
| contexts | [aiInteractionContext](../resources/aiinteractioncontext.md) collection | The identifer that maps to all contexts associated with an interaction. |
32+
| conversationType | String | The type of the conversation. For example, `appchat` or `bizchat`. |
33+
| createdDateTime | DateTime | The time when the interaction was created. |
34+
| etag | String | The timestamp of when the interaction was last modified. |
35+
| from | [identitySet](../resources/identityset.md) | The user, application, or device that is associated with this interaction. |
36+
| id | String | The identifier for the message. |
37+
| interactionType | [aiInteractionType](#aiinteractiontype-values) | Indicates whether the interaction is a prompt or a Copilot response. Possible values are `userPrompt`, `aiResponse`, `unknownFutureValue`. |
38+
| links | [aiInteractionLink](../resources/aiinteractionlink.md) collection | The collection of links that appear in the interaction. |
39+
| locale | String | The locale of the sender. |
40+
| mentions | [aiInteractionMention](../resources/aiinteractionmention.md) collection | The collection of the entities that were mentioned in the interaction, including users, bots, and so on. |
41+
| requestId | String | The identifier that groups a user prompt with its Copilot response. |
42+
| sessionId | String | The thread ID or conversation identifier that maps to all Copilot sessions for the user. |
43+
44+
### aiInteractionType values
45+
46+
| Member | Description |
47+
| ---------- | ---------- |
48+
| userPrompt | A user prompt in the interaction. |
49+
| aiResponse | A Copilot response to the prompt. |
50+
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
51+
52+
## Relationships
53+
54+
None.
55+
56+
## JSON representation
57+
58+
The following JSON representation shows the resource type.
59+
60+
<!--{
61+
"blockType": "resource",
62+
"optionalProperties": [],
63+
"keyProperty": "id",
64+
"baseType": "microsoft.graph.entity",
65+
"@odata.type": "microsoft.graph.aiInteraction"
66+
}-->
67+
68+
```json
69+
{
70+
"appClass": "String",
71+
"attachments": [{"@odata.type": "microsoft.graph.aiInteractionAttachment"}],
72+
"body": {"@odata.type": "microsoft.graph.itemBody"},
73+
"contexts": [{"@odata.type": "microsoft.graph.aiInteractionContext"}],
74+
"conversationType": "String",
75+
"createdDateTime": "String (timestamp)",
76+
"etag": "String",
77+
"from": {"@odata.type": "microsoft.graph.identitySet"},
78+
"id": "String (identifier)",
79+
"interactionType": "String",
80+
"links": [{"@odata.type": "microsoft.graph.aiInteractionLink"}],
81+
"locale": "String",
82+
"mentions": [{"@odata.type": "microsoft.graph.aiInteractionMention"}],
83+
"requestId": "String",
84+
"sessionId": "String"
85+
}
86+
```

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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: "aiInteractionAttachment resource type"
3+
description: "Represents a message attachment, such as cards and images."
4+
ms.date: 11/18/2024
5+
doc_type: resourcePageType
6+
ms.localizationpriority: medium
7+
author: "bkeerthivasa"
8+
ms.subservice: "teams"
9+
toc.title: "AI interaction attachment"
10+
---
11+
12+
# aiInteractionAttachment resource type
13+
14+
Namespace: microsoft.graph
15+
16+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
17+
18+
Represents a message attachment, such as cards and images.
19+
20+
## Properties
21+
22+
| Property | Type | Description |
23+
|:---------------|:--------|:----------|
24+
| attachmentId | String | The identifier for the attachment. This identifier is only unique within the message scope. |
25+
| content | String | The content of the attachment. |
26+
| contentType | String | The type of the content. For example, `reference`, `file`, and `image/imageType`. |
27+
| contentUrl | String | The URL of the content. |
28+
| name | String | The name of the attachment. |
29+
30+
## Relationships
31+
32+
None.
33+
34+
## JSON representation
35+
36+
The following JSON representation shows the resource type.
37+
38+
<!--{
39+
"blockType": "resource",
40+
"optionalProperties": [],
41+
"keyProperty": "id",
42+
"baseType": "microsoft.graph.entity",
43+
"@odata.type": "microsoft.graph.aiInteractionAttachment"
44+
}-->
45+
46+
```json
47+
{
48+
"attachmentId": "String",
49+
"content": "String",
50+
"contentType": "String",
51+
"contentUrl": "String",
52+
"name": "String"
53+
}
54+
```
55+

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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "aiInteractionContext resource type"
3+
description: "Represents all contexts associated with an interaction."
4+
ms.date: 11/18/2024
5+
doc_type: resourcePageType
6+
ms.localizationpriority: medium
7+
author: "bkeerthivasa"
8+
ms.subservice: "teams"
9+
toc.title: "AI interaction context"
10+
---
11+
12+
# aiInteractionContext resource type
13+
14+
Namespace: microsoft.graph
15+
16+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
17+
18+
Represents all contexts associated with an interaction.
19+
20+
## Properties
21+
22+
| Property | Type | Description |
23+
|:---------------|:--------|:----------|
24+
| contextReference | String | The full file URL where the interaction happened. |
25+
| contextType | String | The type of the file. |
26+
| displayName | String | The name of the file. |
27+
28+
## Relationships
29+
30+
None.
31+
32+
## JSON representation
33+
34+
The following JSON representation shows the resource type.
35+
36+
<!--{
37+
"blockType": "resource",
38+
"optionalProperties": [],
39+
"keyProperty": "id",
40+
"baseType": "microsoft.graph.entity",
41+
"@odata.type": "microsoft.graph.aiInteractionContext"
42+
}-->
43+
44+
```json
45+
{
46+
"contextReference": "String",
47+
"contextType": "String",
48+
"displayName": "String"
49+
}
50+
```

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

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: "aiInteractionHistory resource type"
3+
description: "Represents a list of messages exchanged involving AI."
4+
ms.date: 11/15/2024
5+
doc_type: resourcePageType
6+
ms.localizationpriority: medium
7+
author: "bkeerthivasa"
8+
ms.subservice: "teams"
9+
toc.title: "AI interaction history"
10+
---
11+
12+
# aiInteractionHistory resource type
13+
14+
Namespace: microsoft.graph
15+
16+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
17+
18+
Represents a list of messages exchanged involving AI.
19+
20+
## Methods
21+
22+
| Method | Return Type | Description|
23+
|:---------------|:--------|:----------|
24+
|[List all enterprise interactions](../api/aiinteractionhistory-getallenterpriseinteractions.md) | [aiinteraction](aiinteraction.md) collection | Get all Microsoft 365 Copilot interactions data, including user prompts to Copilot and the Copilot responses. |
25+
26+
## Properties
27+
None.
28+
29+
## Relationships
30+
| Relationship | Type | Description |
31+
|:--------------|:---------|:------------|
32+
| interactions | [aiInteraction](../resources/aiinteraction.md) collection| The list of AI interactions. |
33+
34+
35+
## JSON representation
36+
37+
The following JSON representation shows the resource type.
38+
39+
<!--{
40+
"blockType": "resource",
41+
"optionalProperties": [],
42+
"keyProperty": "id",
43+
"baseType": "microsoft.graph.entity",
44+
"@odata.type": "microsoft.graph.aiInteractionHistory"
45+
}-->
46+
47+
```json
48+
{
49+
"interactions": [{"@odata.type": "microsoft.graph.aiinteraction"}],
50+
}
51+
```

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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "aiInteractionLink resource type"
3+
description: "Represents the links that appear in the interaction."
4+
ms.date: 11/18/2024
5+
doc_type: resourcePageType
6+
ms.localizationpriority: medium
7+
author: "bkeerthivasa"
8+
ms.subservice: "teams"
9+
toc.title: "AI interaction link"
10+
---
11+
12+
# aiInteractionLink resource type
13+
14+
Namespace: microsoft.graph
15+
16+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
17+
18+
Represents the links that appear in AI interactions.
19+
20+
## Properties
21+
22+
| Property | Type | Description |
23+
|:---------------|:--------|:----------|
24+
| displayName | String | The name of the link. |
25+
| linkType | String | Information about a link in an app chat or Business Chat (BizChat) interaction. |
26+
| linkUrl | String | The URL of the link. |
27+
28+
## Relationships
29+
30+
None.
31+
32+
## JSON representation
33+
34+
The following JSON representation shows the resource type.
35+
36+
<!--{
37+
"blockType": "resource",
38+
"optionalProperties": [],
39+
"keyProperty": "id",
40+
"baseType": "microsoft.graph.entity",
41+
"@odata.type": "microsoft.graph.aiInteractionLink"
42+
}-->
43+
44+
```json
45+
{
46+
"displayName": "String",
47+
"linkType": "String",
48+
"linkUrl": "String"
49+
}
50+
```

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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "aiInteractionMention resource type"
3+
description: "Represents a mention of an entity in an AI interaction."
4+
ms.date: 11/18/2024
5+
doc_type: resourcePageType
6+
ms.localizationpriority: medium
7+
author: "bkeerthivasa"
8+
ms.subservice: "teams"
9+
toc.title: "AI interaction mention"
10+
---
11+
12+
# aiInteractionMention resource type
13+
14+
Namespace: microsoft.graph
15+
16+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
17+
18+
Represents a mention of an entity in an AI interaction.
19+
20+
## Properties
21+
22+
| Property | Type | Description |
23+
|:---------------|:--------|:----------|
24+
| mentioned | [aiInteractionMentionedIdentitySet](../resources/aiinteractionmentionedidentityset.md) | The entity mentioned in the message. |
25+
| mentionId | Int32 | The identifier for the mention. |
26+
| mentionText | String | The text mentioned in the message. |
27+
28+
## Relationships
29+
30+
None.
31+
32+
## JSON representation
33+
34+
The following JSON representation shows the resource type.
35+
36+
<!--{
37+
"blockType": "resource",
38+
"optionalProperties": [],
39+
"keyProperty": "id",
40+
"baseType": "microsoft.graph.entity",
41+
"@odata.type": "microsoft.graph.aiInteractionMention"
42+
}-->
43+
44+
```json
45+
{
46+
"mentioned": {"@odata.type": "microsoft.graph.AiInteractionMentionedIdentitySet"},
47+
"mentionId": "Int32",
48+
"mentionText": "String"
49+
}
50+
```

0 commit comments

Comments
 (0)