Skip to content
Merged
14 changes: 7 additions & 7 deletions office-365-management-api/copilot-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ ms.localizationpriority: high

For [auditing](/purview/audit-solutions-overview), details are [captured](/purview/audit-log-activities#copilot-activities) when users interact with Copilot. Events include how and when users interact with Copilot, in which Microsoft 365 service the activity took place, and references to the files stored in Microsoft 365 that were accessed during the interaction. If these files have a sensitivity label applied, that's also captured.

Copilot events can be accessed in the **Audit** solution from the Microsoft Purview compliance portal. To search for copilot events, select **Copilot activities** and **Interacted with Copilot**. You can also select **Copilot** as a workload. More information on searching the audit log can be found in [Audit New Search](/purview/audit-new-search).
Copilot events can be accessed in the **Audit** solution from the Microsoft Purview compliance portal. To search for Copilot events, select **Copilot activities** and **Interacted with Copilot**. You can also select **Copilot** as a workload. More information on searching the audit log can be found in [Audit New Search](/purview/audit-new-search).

![audit search copilot interaction dialog box](images/audit-search-copilot-interaction.png)
![audit search Copilot interaction dialog box](images/audit-search-copilot-interaction.png)

## Schema example

Expand Down Expand Up @@ -93,7 +93,7 @@ Copilot events can be accessed in the **Audit** solution from the Microsoft

## Audit log examples of CopilotInteraction

Copilot Interaction logs provide information regarding the RecordID, CreationDate, RecordType, Operation, UserID, and the Audit Data field. The Audit Data field will include any additional information based on the context of user interaction with Copilot, which can include the AppHost, Contexts, ThreadID, MessageIDs, and AccessedResources. More information regarding each of these copilot schema properties can be found in the Audit copilot schema definition section.
Copilot Interaction logs provide information regarding the RecordID, CreationDate, RecordType, Operation, UserID, and the Audit Data field. The Audit Data field will include any additional information based on the context of user interaction with Copilot, which can include the AppHost, Contexts, ThreadID, MessageIDs, and AccessedResources. More information regarding each of these Copilot schema properties can be found in the Audit Copilot schema definition section.

Example 1: Copilot Interaction Experience within M365 Apps (e.g. Word)

Expand All @@ -113,15 +113,15 @@ Example 2: Copilot Interaction within M365 Chat Experience on Bing
- UserID: admin@MODERNCOMMS975184.onmicrosoft.com
- AuditData: {"CreationTime":"2023-12-14T02:11:55","Id":"537312b6-dce7-4d9b-8b12-58283204b720","Operation":"CopilotInteraction","OrganizationId":"408e31c8-8f05-410a-9221-84335f0ce512","RecordType":261,"UserKey":"12d24f71-64c7-49b3-821f-f8884f3f373e","UserType":0,"Version":1,"Workload":"Copilot","ClientIP":"2401:4900:60d2:179b:c004:b6f:b678:b148","ClientRegion":"IN","UserId":"admin@MODERNCOMMS975184.onmicrosoft.com","CopilotEventData":{"AISystemPlugin":[{"Id":"BingWebSearch","Name":"BuiltIn"}],"AccessedResources":[{"Action":"Read","Id":"AAAAAEYE2GAACp1FlnN_CHXStUkHAGWJYgtgcv1eOxe2v4H4jOsAAAQsLLeAAGWJYgtgcv1EoXe2v4H4josAABwvq8gAAA2","Name":"Document1.docx","SensitivityLabelId":"f41ab342-8706-4188-bd11-ebb85995028c","SiteUrl":"https:\/\/microsoft.sharepoint.com\/teams\/OfficeSerbia\/Shared%20Documents\/SPOPPE\/Document%20transformation%20services\/Crawled%20Word%20documents\/IW\/Document1.docx?web=1","Type":"docx","listItemUniqueId":"AAAAAEYE2GAACp1FlnN_CHXStUkHAGWJYgtgcv1eOxe2v4H4jOsAAAQsLLeAAGWJYgtgcv1EoXe2v4H4josAABwvq8gAAA2"}],"AppHost":"Bing","Contexts":[],"MessageIds":[],"Messages":[{"Id":"1715186983849","isPrompt":true},{"Id":"1715186984291","isPrompt":false}],"ModelTransparencyDetails":[{"ModelName":"DEEP_LEO"}],"ThreadId":"19:Xn3uQZYgZ7f2ue0vp5w9MglEVjFyp5pza1efaC6g2U41@thread.v2"}}

## Audit copilot schema definitions
## Audit Copilot schema definitions

|Attribute |Definition |
|----------|------------|
|*ClientRegion* |The user’s region when they performed the operation. |
|*AISystemPlugin* |Details of plugins or extensions enabled for the Coplot interaction. |
|*AISystemPlugin* |Details of plugins or extensions enabled for the Copilot interaction. |
|*AppHost* |The type of Copilot used during the interaction. <br> The current list of values include Bing, Teams, Outlook, Office, DevUI, BashTool, Word, Excel, PowerPoint, OneNote, SharePoint, Loop, Whiteboard, M365App, M365AdminCenter, Planner, VivaEngage, VivaCopilot, Stream, Assist365, VivaGoals. |
|*Contexts* |Context contains a collection of attributes within AppChat around the user interaction to help describe where the user was during the copilot interaction. ID is identifier of the resource that was being used during the copilot interaction. Type is the name of the app or service within context. <br>Example: Some examples of supported apps and services include M365 Office (docx, pptx, xlsx), TeamsMeeting, TeamsChannel, and TeamsChat. If Copilot is used in Excel, then context will be the identifier of the Excel Spreadsheet and the file type. |
|*ThreadId* |The ID of the copilot and user interaction thread. |
|*Contexts* |Context contains a collection of attributes within AppChat around the user interaction to help describe where the user was during the Copilot interaction. ID is identifier of the resource that was being used during the Copilot interaction. Type is the name of the app or service within context. <br>Example: Some examples of supported apps and services include M365 Office (docx, pptx, xlsx), TeamsMeeting, TeamsChannel, and TeamsChat. If Copilot is used in Excel, then context will be the identifier of the Excel Spreadsheet and the file type. |
|*ThreadId* |The ID of the Copilot and user interaction thread. |
|*MessageIds* |This is currently reserved with Microsoft Internal. |
|*Messages* |The ID of the prompt and response messages in the Copilot interaction. |
|*ModelTransparencyDetails* |Details of the AI/GAI model provider. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,17 @@ This article provides details on the Common schema as well as service-specific s
|UserAssignments|Collection (Edm.Guid)|No|Collection of GUID of Users and Groups associated with the agent activity.|
|ForAllUsers|Edm.Boolean|Yes|Whether the activity associated with the agent was captured for the entire organization or not. True when it applies to all users in the organization. False when it applies to specific users/group.|

### AgentSettingsAdminActivity

| Parameters|Type|Mandatory?|Description|
| -------- | -------- | -------- | -------- |
|Property |Edm.String|Yes|The tenant wide setting name that was updated by the admin.|
|RemovedIdentities|Collection(Edm.Guid)|No|Collection of GUID of Users or Groups that were removed.|
|AddedIdentities|Collection(Edm.Guid)|No|Collection of GUID of Users or Groups that were added. |
|NewValue|Edm.String|Yes|The new value of the setting.|
|ForAllUsers|Edm.Boolean|Yes|Boolean value indicating if the tenant wide setting impacted all users.|
| OldValue |Edm.String|Yes |The old value or the new setting.|

### Enum: AuditLogRecordType - Type: Edm.Int32

#### AuditLogRecordType
Expand Down Expand Up @@ -361,6 +372,7 @@ This article provides details on the Common schema as well as service-specific s
|387|PlannerGoalList|Microsoft Planner goal list events.|
|414|VivaEngageSegment|Viva Engage segmentation events.|
|422|VivaEngageEvents|Events related to Viva Engage hosted events.|
|427|UniversalPrintManagement| Audit events related to Management events in Microsoft Universal Print.|

### Enum: User Type - Type: Edm.Int32

Expand Down