@microsoft/app-manifest 1.0.5 → 1.0.6-alpha.bca8bf68d3.0

package/build/json-schemas/copilot/declarative-agent/v1.3/schema.json

@@ -0,0 +1,610 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "$comment": "This schema describes the constraints of a declarative agent for third party developers to be deployed to Microsoft 365 Copilot",
+    "type": "object",
+    "title": "Declarative agent manifest object",
+    "description": "The root of the declarative agent manifest document is a JSON object that contains members that describe the declarative agent.",
+    "properties": {
+        "version": {
+            "description": "Required. Not localizable. The version of the schema this manifest is using.",
+            "type": "string",    
+            "const": "v1.3"
+        },
+        "id": {
+            "description": "Optional. Not localizable.",
+            "type": "string",
+            "pattern": "^(?!\\[\\[)(.*?)(?<!\\]\\])$"
+        },
+        "name": {
+            "type": "string",
+            "description": "Required. Localizable. The name of the declarative agent. It MUST contain at least one nonwhitespace character and MUST be 100 characters or less.",
+            "minLength": 1,
+            "maxLength": 100,
+            "pattern": "^(\\[\\[)[a-zA-Z_][a-zA-Z0-9_]*(\\]\\])$|^(?!(.*?\\[\\[.*?|.*?\\]\\].*?)).*$"
+        },
+        "description": {
+            "type": "string",
+            "description": "Required. Localizable. The description of the declarative agent. It MUST contain at least one nonwhitespace character and MUST be 1,000 characters or less.",
+            "minLength": 1,
+            "maxLength": 1000,
+            "pattern": "^(\\[\\[)[a-zA-Z_][a-zA-Z0-9_]*(\\]\\])$|^(?!(.*?\\[\\[.*?|.*?\\]\\].*?)).*$"
+        },
+        "instructions": {
+            "type": "string",
+            "description": "Optional. Not localizable. The detailed instructions or guidelines on how the declarative agent should behave, its functions, and any behaviors to avoid. It MUST contain at least one nonwhitespace character and MUST be 8,000 characters or less.",
+            "minLength": 1,
+            "maxLength": 8000,
+            "pattern": "^(?!\\[\\[)((.|\\n|\\r)*?)(?<!\\]\\])$"
+        },
+        "capabilities": {
+            "type": "array",
+            "description": "Optional. Contains an array of objects that define capabilities of the declarative agent.",
+            "uniqueItems": true,
+            "items": {
+                "anyOf": [
+                    {
+                        "$ref": "#/$defs/capabilities/base-capability"
+                    }
+                ]
+            }
+        },
+        "conversation_starters": {
+            "type": "array",
+            "description": "Optional. A list of examples of questions that the declarative agent can answer. There MUST NOT be more than six objects in the array.",
+            "maxItems": 6,
+            "minItems": 1,
+            "items": {
+                "$ref": "#/$defs/conversation-starter"
+            }
+        },
+        "actions": {
+            "type": "array",
+            "description": "Optional. A list of objects that identify API plugins that provide actions accessible to the declarative agent.",
+            "minItems": 1,
+            "maxItems": 10,
+            "items": {
+                "oneOf": [
+                    {
+                        "$ref": "#/$defs/action-object"
+                    }
+                ]
+            }
+        }
+    },
+    "required": [
+        "version",
+        "name",
+        "description"
+    ],
+    "propertyNames": {
+        "enum": [
+            "id",
+            "version",
+            "name",
+            "description",
+            "instructions",
+            "capabilities",
+            "conversation_starters",
+            "actions",
+            "$schema"
+        ]
+    },
+    "$defs": {
+        "capabilities": {
+            "base-capability": {
+                "type": "object",
+                "description": "Represents a base capability object.",
+                "properties": {
+                    "name": {
+                        "type": "string",
+                        "description": "Required. The name of the capability. Allowed values are WebSearch, CodeInterpreter, OneDriveAndSharePoint, GraphConnectors, TeamsMessages, Dataverse, Email, People and GraphicArt.",
+                        "anyOf": [
+                            {
+                                "const": "WebSearch"
+                            },
+                            {
+                                "const": "CodeInterpreter"
+                            },
+                            {
+                                "const": "OneDriveAndSharePoint"
+                            },
+                            {
+                                "const": "GraphConnectors"
+                            },
+                            {
+                                "const": "GraphicArt"
+                            },
+                            {
+                                "const": "TeamsMessages"
+                            },
+                            {
+                                "const": "Dataverse"
+                            },
+                            {
+                                "const": "Email"
+                            }, 
+                            {
+                                "const": "People"
+                            }
+                        ]
+                    }
+                },
+                "oneOf": [
+                    {
+                        "$ref": "#/$defs/capabilities/web-search"
+                    },
+                    {
+                        "$ref": "#/$defs/capabilities/onedrive-and-sharepoint"
+                    },
+                    {
+                        "$ref": "#/$defs/capabilities/graph-connectors"
+                    },
+                    {
+                        "$ref": "#/$defs/capabilities/code-interpreter"
+                    },
+                    {
+                        "$ref": "#/$defs/capabilities/graphic-art"
+                    },
+                    {
+                        "$ref": "#/$defs/capabilities/teams-messages"
+                    },
+                    {
+                        "$ref": "#/$defs/capabilities/dataverse"
+                    },
+                    {
+                        "$ref": "#/$defs/capabilities/email"
+                    }, 
+                    {
+                        "$ref": "#/$defs/capabilities/people"
+                    }
+                ],
+                "required": [
+                    "name"
+                ]
+            },
+            "people": {
+                "type": "object",
+                "description": "Indicates that the DA will be able to search people data in the organization.",
+                "properties": {
+                    "name": {
+                        "const": "People",
+                        "description": "Required. Must be set to People."
+                    }
+                },
+                "propertyNames": {
+                    "enum": [
+                        "name"
+                    ]
+                }
+            },
+            "email": {
+                "type": "object",
+                "description": "A JSON object whose presence indicates that the DA will be able to search within Email Messages in the mailboxes user has access to.",
+                "properties": {
+                    "name": {
+                        "const": "Email",
+                        "description": "Required: Must be set to Email"
+                    },
+                    "folders": {
+                        "type": "array",
+                        "description": "A JSON array of Folder Object. This member can be used to constrain the content accessible to the DA to just the emails present in the folders identified by members of each Folder Object.",
+                        "items": {
+                            "$ref": "#/$defs/capabilities/email-folder"
+                        }
+                    },
+                    "shared_mailbox": {
+                        "type": "string",
+                        "description": "A JSON string that contains SMTP address of the shared mailbox. The presence of this field indicates that the DA constrain its search for relevant emails only to that mailbox. Emails from user's primary mailbox is not searched when this field is present."
+                    }
+                },
+                "propertyNames": {
+                    "enum": [
+                        "name",
+                        "folders",
+                        "shared_mailbox"
+                    ]
+                },
+                "required": [
+                    "name"
+                ]
+            },
+            "email-folder": {
+                "type": "object",
+                "properties": {
+                    "folder_id": {
+                        "type": "string",
+                        "description": "A JSON string that identifies an email folder. This can either be id of the folder or one of the well known names.",
+                        "minLength": 1
+                    }
+                },
+                "propertyNames": {
+                    "enum": [
+                        "folder_id"
+                    ]
+                },
+                "required": [
+                    "folder_id"
+                ]
+            },
+            "dataverse": {
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "const": "Dataverse",
+                        "description": "Required: Must be set to Dataverse"
+                    },
+                    "knowledge_sources": {
+                        "type": "array",
+                        "description": "An array of Objects that represent the knowledge sources for the Dataverse in the Declarative Agent",
+                        "items": {
+                            "$ref": "#/$defs/capabilities/dataverse-knowledge-source"
+                        }
+                    }
+                },
+                "propertyNames": {
+                    "enum": [
+                        "name",
+                        "knowledge_sources"
+                    ]
+                }
+            },
+            "dataverse-knowledge-source": {
+                "type": "object",
+                "description": "",
+                "properties": {
+                    "host_name": {
+                        "type": "string",
+                        "description": "A unique identifier for the host in Dataverse."
+                    },
+                    "skill": {
+                        "type": "string",
+                        "description": "A unique identifier that defines the configuration for how the copilot agent interacts with Dataverse knowledge."
+                    },
+                    "tables": {
+                        "type": "array",
+                        "description": "An array of table_name objects which contain table names in DataVerse to scope the knowledge of the Declarative Agent",
+                        "items": {
+                            "$ref": "#/$defs/capabilities/dataverse-knowledge-source-table"
+                        }
+                    }
+                },
+                "propertyNames": {
+                    "enum": [
+                        "host_name",
+                        "skill",
+                        "tables"
+                    ]
+                }
+            },
+            "dataverse-knowledge-source-table": {
+                "type": "object",
+                "properties": {
+                    "table_name": {
+                        "type": "string",
+                        "description": "A string to represent the table name."
+                    }
+                },
+                "propertyNames": {
+                    "enum": [
+                        "table_name"
+                    ]
+                }
+            },
+            "teams-messages": {
+                "type": "object",
+                "description": "Indicates that the declarative agent can search through Teams channels, teams, meetings, 1:1 chats and group chats.",
+                "properties": {
+                    "name": {
+                        "const": "TeamsMessages",
+                        "description": "Required. Must be set to TeamsMessages."
+                    },
+                    "urls": {
+                        "type": "array",
+                        "maxItems": 5,
+                        "description": "This member can be used to constrain the content accessible to the DA to just the content identified via the members of each Teams url",
+                        "items": {
+                            "$ref": "#/$defs/capabilities/teams-url"
+                        }
+                    }
+                },
+                "propertyNames": {
+                   "enum": [
+                        "name",
+                        "urls"
+                    ]
+                }
+            },
+            "teams-url": {
+                "type": "object",
+                "description": "Identifies a Teams channel, team or meeting chat",
+                "properties": {
+                    "url": {
+                        "type": "string",
+                        "description": "A string that contains a well formed, Teams url to a Teams channel, team or meeting chat (join url)"
+                    }
+                },
+                "required": [
+                    "url"
+                ],
+                "propertyNames": {
+                    "enum": [
+                        "url"
+                    ]
+                }
+            },
+            "web-search": {
+                "type": "object",
+                "description": "Indicates that the declarative agent can search the web for grounding information.",
+                "properties": {
+                    "name": {
+                        "const": "WebSearch",
+                        "description": "Required. Must be set to WebSearch."
+                    },
+                    "sites": {
+                        "type": "array",
+                        "minItems": 1,
+                        "maxItems": 4,
+                        "description": "Optional. An array of sites used to constrain the content accessible to the DA to just the content identified via the items of array.",
+                        "items": {
+                            "$ref": "#/$defs/web-search-site"
+                        }
+                    }
+                },
+                "required": [
+                    "name"
+                ],
+                "propertyNames": {
+                    "enum": [
+                        "name",
+                        "sites"
+                    ]
+                }
+            },
+            "code-interpreter": {
+                "type": "object",
+                "description": "Indicates that the declarative agent can generate and execute code.",
+                "properties": {
+                    "name": {
+                        "const": "CodeInterpreter",
+                        "description": "Required. Must be set to CodeInterpreter."
+                    }
+                },
+                "required": [
+                    "name"
+                ],
+                "propertyNames": {
+                    "enum": [
+                        "name"
+                    ]
+                }
+            },
+            "graphic-art": {
+                "type": "object",
+                "description": "Indicates that the declarative agent can images and art based on the text input from the user.",
+                "properties": {
+                    "name": {
+                        "const": "GraphicArt",
+                        "description": "Required. Must be set to GraphicArt."
+                    }
+                },
+                "required": [
+                    "name"
+                ],
+                "propertyNames": {
+                    "enum": [
+                        "name"
+                    ]
+                }
+            },
+            "onedrive-and-sharepoint": {
+                "type": "object",
+                "description": "Indicates that the declarative agent can search a user's SharePoint and OneDrive for grounding information.",
+                "properties": {
+                    "name": {
+                        "const": "OneDriveAndSharePoint",
+                        "description": "Required. Must be set to OneDriveAndSharePoint."
+                    },
+                    "items_by_sharepoint_ids": {
+                        "type": "array",
+                        "minItems": 1,
+                        "description": "Optional. An array of objects that identify SharePoint or OneDrive sources using IDs.",
+                        "items": {
+                            "$ref": "#/$defs/sharepoint-ids"
+                        }
+                    },
+                    "items_by_url": {
+                        "type": "array",
+                        "minItems": 1,
+                        "description": "Optional. An array of objects that identify SharePoint or OneDrive sources by URL.",
+                        "items": {
+                            "$ref": "#/$defs/sharepoint-url"
+                        }
+                    }
+                },
+                "required": [
+                    "name"
+                ],
+                "propertyNames": {
+                    "enum": [
+                        "name",
+                        "items_by_sharepoint_ids",
+                        "items_by_url"
+                    ]
+                }
+            },
+            "graph-connectors": {
+                "type": "object",
+                "description": "Indicates that the declarative agent can search selected Microsoft Graph connectors for grounding information.",
+                "properties": {
+                    "name": {
+                        "const": "GraphConnectors",
+                        "description": "Required. Must be set to GraphConnectors."
+                    },
+                    "connections": {
+                        "type": "array",
+                        "minItems": 1,
+                        "description": "Optional. An array of objects that identify the Microsoft Graph connectors available to the declarative agent",
+                        "items": {
+                            "$ref": "#/$defs/connection"
+                        }
+                    }
+                },
+                "required": [
+                    "name"
+                ],
+                "propertyNames": {
+                    "enum": [
+                        "name",
+                        "connections"
+                    ]
+                }
+            }
+        },
+        "web-search-site": {
+            "type": "object",
+            "description": "An object that identifies a site used to constrain the content accessible to the declarative agent.",
+            "properties": {
+                "url": {
+                    "type": "string",
+                    "description": " An absolute URL to a site."
+                }
+            },
+            "required": [
+                "url"
+            ],
+            "propertyNames": {
+                "enum": [
+                    "url"
+                ]
+            }
+        },
+        "conversation-starter": {
+            "type": "object",
+            "description": "Contains hints that are displayed to the user to demonstrate how they can get started using the declarative agent.",
+            "properties": {
+                "text": {
+                    "type": "string",
+                    "description": "Required. Localizable. A suggestion that the user can use to obtain the desired result from the DC. It MUST contain at least one nonwhitespace character.",
+                    "pattern": "^(\\[\\[)[a-zA-Z_][a-zA-Z0-9_]*(\\]\\])$|^(?!(.*?\\[\\[.*?|.*?\\]\\].*?)).*$"
+                },
+                "title": {
+                    "type": "string",
+                    "description": "Optional. Localizable. A unique title for the conversation starter. It MUST contain at least one nonwhitespace character.",
+                    "pattern": "^(\\[\\[)[a-zA-Z_][a-zA-Z0-9_]*(\\]\\])$|^(?!(.*?\\[\\[.*?|.*?\\]\\].*?)).*$"
+                }
+            },
+            "required": [
+                "text"
+            ],
+            "propertyNames": {
+                "enum": [
+                    "text",
+                    "title"
+                ]
+            }
+        },
+        "action-object": {
+            "type": "object",
+            "description": "Identifies an API plugin manifest for a plugin used as an action by the declarative agent.",
+            "properties": {
+                "id": {
+                    "type": "string",
+                    "description": "Required. Not localizable. A unique identifier for the action. It MAY be represented by a GUID.",
+                    "pattern": "^(?!\\[\\[)(.*?)(?<!\\]\\])$"
+                },
+                "file": {
+                    "type": "string",
+                    "description": "Required. Not localizable. A path to the API plugin manifest for this action.",
+                    "pattern": "^(?!\\[\\[)(.*?)(?<!\\]\\])$"
+                }
+            },
+            "required": [
+                "id",
+                "file"
+            ],
+            "propertyNames": {
+                "enum": [
+                    "id",
+                    "file"
+                ]
+            }
+        },
+        "sharepoint-ids": {
+            "type": "object",
+            "description": "Contains one or more object identifiers that identify a SharePoint or OneDrive resource.",
+            "properties": {
+                "site_id": {
+                    "type": "string",
+                    "description": "Optional. Not localizable. The GUID identifier of a SharePoint or OneDrive site.",
+                    "pattern": "^(?!\\[\\[)(.*?)(?<!\\]\\])$"
+                    
+                },
+                "web_id": {
+                    "type": "string",
+                    "description": "Optional. Not localizable. The GUID identifier of a SharePoint or OneDrive web.",
+                    "pattern": "^(?!\\[\\[)(.*?)(?<!\\]\\])$"
+                },
+                "list_id": {
+                    "type": "string",
+                    "description": "Optional. Not localizable. The GUID identifier of a SharePoint or OneDrive list.",
+                    "pattern": "^(?!\\[\\[)(.*?)(?<!\\]\\])$"
+                },
+                "unique_id": {
+                    "type": "string",
+                    "description": "Optional. Not localizable. The GUID identifier of a SharePoint or OneDrive item.",
+                    "pattern": "^(?!\\[\\[)(.*?)(?<!\\]\\])$"
+                },
+                "search_associated_sites": {
+                    "type": "boolean",
+                    "description": "Boolean value indicating whether to enable searching associated sites. This value is only applicable when the site_id value references a SharePoint HubSite."
+                }
+            },
+            "propertyNames": {
+                "enum": [
+                    "site_id",
+                    "web_id",
+                    "list_id",
+                    "unique_id",
+                    "search_associated_sites"
+                ]
+            },
+            "additionalProperties": false
+        },
+        "sharepoint-url": {
+            "type": "object",
+            "description": "Represents the URL of a SharePoint or OneDrive resource.",
+            "properties": {
+                "url": {
+                    "type": "string",
+                    "description": "Optional. Not localizable. An absolute URL to a SharePoint or OneDrive resource.",
+                    "pattern": "^(?!\\[\\[)(.*?)(?<!\\]\\])$"
+                }
+            },
+            "propertyNames": {
+                "enum": [
+                    "url"
+                ]
+            },
+            "additionalProperties": false
+        },
+        "connection": {
+            "type": "object",
+            "description": "Identifies a Microsoft Graph connector.",
+            "properties": {
+                "connection_id": {
+                    "type": "string",
+                    "description": "Required. Not localizable The unique identifier of the Microsoft Graph connector.",
+                    "pattern": "^(?!\\[\\[)(.*?)(?<!\\]\\])$"
+                }
+            },
+            "required": [
+                "connection_id"
+            ],
+            "propertyNames": {
+                "enum": [
+                    "connection_id"
+                ]
+            }
+        }
+    }
+}