Microsoft Copilot · Schema

AiInteraction

Represents an interaction between a user and Copilot across Microsoft 365 applications.

AgentsAI AssistantArtificial IntelligenceChatbotCopilotExtensibilityGenerative AIMicrosoft 365Productivity

Properties

Name Type Description
id string The unique identifier for the interaction message.
appClass string The data source for Copilot data. For example, IPM.SkypeTeams.Message.Copilot.Excel or IPM.SkypeTeams.Message.Copilot.Loop.
interactionType string Indicates whether the interaction is a user prompt or a Copilot response.
conversationType string The type of the conversation (e.g., appchat, bizchat).
requestId string Identifier that groups a user prompt with its corresponding Copilot response.
sessionId string Thread ID or conversation identifier that maps to all Copilot sessions for the user.
createdDateTime string The time when the interaction was created.
etag string Timestamp of when the interaction was last modified.
locale string The locale of the sender.
attachments array Collection of documents attached to the interaction, such as cards and images.
contexts array Identifiers that map to all contexts associated with the interaction.
links array Collection of links that appear in the interaction.
mentions array Collection of entities mentioned in the interaction, including users and bots.
View JSON Schema on GitHub

JSON Schema

microsoft-copilot-ai-interaction-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "AiInteraction",
  "type": "object",
  "description": "Represents an interaction between a user and Copilot across Microsoft 365 applications.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the interaction message."
    },
    "appClass": {
      "type": "string",
      "description": "The data source for Copilot data. For example, IPM.SkypeTeams.Message.Copilot.Excel or IPM.SkypeTeams.Message.Copilot.Loop."
    },
    "interactionType": {
      "type": "string",
      "description": "Indicates whether the interaction is a user prompt or a Copilot response."
    },
    "conversationType": {
      "type": "string",
      "description": "The type of the conversation (e.g., appchat, bizchat)."
    },
    "requestId": {
      "type": "string",
      "description": "Identifier that groups a user prompt with its corresponding Copilot response."
    },
    "sessionId": {
      "type": "string",
      "description": "Thread ID or conversation identifier that maps to all Copilot sessions for the user."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The time when the interaction was created."
    },
    "etag": {
      "type": "string",
      "description": "Timestamp of when the interaction was last modified."
    },
    "locale": {
      "type": "string",
      "description": "The locale of the sender."
    },
    "attachments": {
      "type": "array",
      "description": "Collection of documents attached to the interaction, such as cards and images."
    },
    "contexts": {
      "type": "array",
      "description": "Identifiers that map to all contexts associated with the interaction."
    },
    "links": {
      "type": "array",
      "description": "Collection of links that appear in the interaction."
    },
    "mentions": {
      "type": "array",
      "description": "Collection of entities mentioned in the interaction, including users and bots."
    }
  }
}