aiInteraction resource type

Important

APIs under the /beta version are subject to change. Use of these APIs in production applications is not supported.

Represents an interaction between a user and Copilot.

Note

For information about the AI interactions that are included with this API and the relevant licensing requirements, see Licensing and prerequisites and AI interactions returned.

Methods

None.

Properties

Property	Type	Description
appClass	String	The data source for Copilot data. For example, IPM.SkypeTeams.Message.Copilot.Excel or IPM.SkypeTeams.Message.Copilot.Loop.
attachments	aiInteractionAttachment collection	The collection of documents attached to the interaction, such as cards and images.
body	itemBody	The body of the message, including the text of the body and its body type.
contexts	aiInteractionContext collection	The identifier that maps to all contexts associated with an interaction.
conversationType	String	The type of the conversation. For example, appchat or bizchat.
createdDateTime	DateTime	The time when the interaction was created.
etag	String	The timestamp of when the interaction was last modified.
from	identitySet	The user, application, or device that is associated with this interaction.
id	String	The identifier for the message.
interactionType	aiInteractionType	Indicates whether the interaction is a prompt or a Copilot response. Possible values are userPrompt, aiResponse, unknownFutureValue.
links	aiInteractionLink collection	The collection of links that appear in the interaction.
locale	String	The locale of the sender.
mentions	aiInteractionMention collection	The collection of the entities that were mentioned in the interaction, including users, bots, and so on.
requestId	String	The identifier that groups a user prompt with its Copilot response.
sessionId	String	The thread ID or conversation identifier that maps to all Copilot sessions for the user.

aiInteractionType values

Member	Description
userPrompt	A user prompt in the interaction.
aiResponse	A Copilot response to the prompt.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "appClass": "String",
  "attachments": [{"@odata.type": "microsoft.graph.aiInteractionAttachment"}],
  "body": {"@odata.type": "microsoft.graph.itemBody"},
  "contexts": [{"@odata.type": "microsoft.graph.aiInteractionContext"}],
  "conversationType": "String",
  "createdDateTime": "String (timestamp)",
  "etag": "String",
  "from": {"@odata.type": "microsoft.graph.identitySet"},
  "id": "String (identifier)",
  "interactionType": "String",
  "links": [{"@odata.type": "microsoft.graph.aiInteractionLink"}],
  "locale": "String",
  "mentions": [{"@odata.type": "microsoft.graph.aiInteractionMention"}],
  "requestId": "String",
  "sessionId": "String"
}