Compartilhar via

root.copilotAgents object

  • Artigo

Defines one or more agents to Microsoft 365 Copilot. Declarative agents are customizations of Microsoft 365 Copilot that run on the same orchestrator and foundation models. Custom engine agents are conversational Teams bots that use custom AI language models and orchestration, yet are selectable (along with installed declarative agents) as Agents from the Microsoft 365 Copilot side panel.

Note

Custom engine agents support in Microsoft 365 Copilot is currently in public preview.

Properties that reference this object type:

Syntax

{
  "declarativeAgents": [
    {
      "id": "{string}",
      "file": "{string}"
    }
  ],
  "customEngineAgents": [
    {
      "id": "{string}",
      "type": "bot"
    }
  ]
}

{
  "declarativeAgents": [
    {
      "id": "{string}",
      "file": "{string}"
    }
  ]
}

Properties

declarativeAgents

Array of objects that each define a declarative agent.

Type
Array of declarativeAgentRef

Required
—

Constraints
Minimum array items: 1. Maximum array items: 1.

Supported values

declarativeAgents

Array of objects that each define a declarative agent.

Type
Array of declarativeAgentRef

Required
✅

Constraints
Minimum array items: 1. Maximum array items: 1.

Supported values

customEngineAgents

Array of objects that each define a custom engine agent.

Type
Array of customEngineAgents

Required
—

Constraints
Minimum array items: 1. Maximum array items: 1.

Supported values

Remarks

Note

Custom engine agents support in Microsoft 365 Copilot is currently in limited private preview and not all developers have access during the staged rollout.

Examples

{
    "copilotAgents": {
        "declarativeAgents": [
            {
                "id": "agent1",
                "file": "declarativeAgent1.json"
            }
        ]
    }
}