Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
APIs under the /beta version are subject to change. Use of these APIs in production applications is not supported.
Represents a Copilot conversation being created or continued through the Microsoft 365 Copilot Chat API.
Methods
| Method | Return type | Description |
|---|---|---|
| Create | copilotConversation |
Create a new Copilot conversation. |
| Chat | copilotConversation |
Send a chat message to Copilot and receive a response synchronously. |
| Chat over stream | stream of copilotConversation |
Send a chat message to Copilot and receive a streaming response. |
Properties
| Property | Type | Description |
|---|---|---|
createdDateTime |
DateTimeOffset | The timestamp when the Copilot conversation was created. |
displayName |
String | The display name for the Copilot conversation. |
id |
String | The identifier for a Copilot conversation. This is used as a path parameter when continuing a synchronous or streamed conversation. |
messages |
copilotConversationResponseMessage collection | The latest turn count in the conversation when the last message was added. |
state |
copilotConversationState | The Copilot conversation state. |
turnCount |
Int32 | The latest turn count in the conversation when the last message was added. |
copilotConversationState enumeration
An evolvable enumeration with the following possible values.
| Value |
|---|
active |
disengagedForRai |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.copilotConversation",
"id": "String",
"createdDateTime": "DateTimeOffset",
"displayName": "String",
"state": "String",
"turnCount": "Int32",
"messages": [
{
"@odata.type": "#microsoft.graph.copilotConversationResponseMessage"
}
]
}