Рекомендации по созданию и обновлению агентов Copilot
Важно!
- Подключаемые модули для Microsoft 365 Copilot доступны в предварительной версии и работают только в Microsoft 365 Copilot.
- Подключаемые модули расширения сообщений доступны в предварительной версии.
- Подключаемые модули расширений сообщений в Microsoft 365 Copilot доступны в общедоступной предварительной версии для Microsoft Word и PowerPoint.
- Убедитесь, что Microsoft 365 Copilot доступны для вашей организации. Вы можете получить среду разработчика для Microsoft 365 Copilot двумя способами:
- Клиент песочницы Microsoft 365 с Microsoft 365 Copilot (доступна в ограниченной предварительной версии через членство в TAP).
- Корпоративная клиентская рабочая среда с Microsoft 365 Copilot лицензиями. Дополнительные сведения о рекомендациях по проверке для агентов Copilot, чтобы увеличить их шансы на включение в team Store, см. в разделе Рекомендации по проверке для агентов Copilot.
Подключаемые модули Microsoft 365 обеспечивают интеграцию с различными продуктами Microsoft 365, такими как Teams и Outlook. Интеграция помогает пользователям искать или создавать содержимое во внешних системах. Подключаемые модули расширения сообщений позволяют Microsoft 365 Copilot взаимодействовать с API из другого программного обеспечения и служб через бота. С помощью Microsoft 365 Copilot вы можете:
- Поиск последних сведений или записей. Например, последний запрос на инцидент или результаты опроса.
- Суммирование сведений на основе нескольких записей. Например, сведите все билеты на инциденты, связанные с проектом Northwind.
Рекомендуется создавать или обновлять существующие расширения сообщений, чтобы максимально повысить их полезность и удобство использования в Microsoft 365 Copilot. Расширения сообщений должны поддерживать одну или несколько команд поиска. Поскольку Microsoft 365 Copilot распознает их как навыки, он может выполнять команды от имени пользователя.
Определение описаний приложений, команд и параметров
[Необходимо исправить]
Хорошее описание содержит четкое и краткое описание функций приложения и позволяет Microsoft 365 Copilot эффективно обнаруживать и выполнять операции поиска. Когда пользователь вводит имя приложения вместе с командой, например Найти билеты Contoso, подключаемый модуль расширения сообщений должен вызываться из Microsoft 365 Copilot.
Описание приложения
Длинные и короткие описания приложений должны быть четкими и определять область приложения. Чтобы отобразить приложение в виде подключаемого модуля в Microsoft 365 Copilot, измените описание приложения в соответствии со следующими требованиями к подключаемого модулям:
- Длинное описание должно четко объяснять функции и использование подключаемого модуля расширения сообщений в Microsoft 365 Copilot. Например, используйте облако Contoso в Microsoft 365 Copilot для поиска и подведения итогов по задачам.
- Краткое описание должно кратко описывать функциональные возможности приложения на естественном языке и включать имя приложения.
В следующих фрагментах кода показаны краткие примеры описания для каждой категории:
Описание: создание, поиск, просмотр билетов, ошибок и проектов.
Пример описания приложения:
{
"$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.13/MicrosoftTeams.schema.json",
"version": "1.0.0",
"manifestVersion": "1.13",
"id": "2bxxxxc5-5xxx-4xxx-aXXX-94xxxx8919e5",
"name": {
"short": "Tasks",
"full": "Contoso Tasks"
},
"description": {
"short": "Create, search, view tickets, bugs, and projects",
"full": "Contoso Tasks makes it easy to stay organized. Create, assign, and track tasks individually or collaboratively with your team, and see everything come together in one place."
},
Описание команды поиска
Описание команды сопоставляет намерения и высказывания пользователя с командой поиска в подключаемом модуле и должно быть построено на основе анализа намерения пользователя и ключевых слов. Описания команд поиска должны:
- Сосредоточьтесь на том, что и как команда выполняет поиск (подробный список) на естественном языке.
- Если применимо, включите глаголы и синонимы.
- Сосредоточьтесь на ключевых словах, которые, скорее всего, будут использоваться в функции поиска собственных приложений.
Семантическое описание
[Хорошо для исправления]
Свойство semanticDescription используется для предоставления подробного описания команды для Microsoft 365 Copilot. Семантическое описание команд поддерживает до 5000 символов и не отображается в пользовательском интерфейсе.
semanticDescription Если свойство остается пустым, Microsoft 365 Copilot использует сведения в description поле . При написании semanticDescriptionнеобходимо включить сведения об ожидаемых значениях, ограничениях и диапазонах для команды .
Свойство semanticDescription не является обязательным полем. Однако при добавлении semanticDescription в манифест приложения существующие проверки для кратких, параметров и описаний команд также применимы для семантических описаний.
В следующих фрагментах кода показаны примеры команд и семантического описания для каждой категории:
Описание. Найдите высокоприоритетные задачи, связанные с Northwind, которые должны быть запланированы завтра.
Пример описания команды:
"commands": [
{
"id": "Search",
"type": "query",
"title": "Tasks",
"description": "Search for high priority tasks related to Northwind that are due tomorrow.",
"SemanticDescription": "Search for issues, epics, stories, tasks, sub tasks, bugs + additional details."
"initialRun": true,
"fetchTask": false,
"context": [
"commandBox",
"compose",
"message"
],
Важно!
Чтобы активировать ссылку для входа OAuth в подключаемом модуле, убедитесь, что для команды поиска в манифесте приложения задано initialRun значение true .
Описание параметра
Каждая команда расширения сообщений имеет соответствующее parameters свойство, которое поддерживает до пяти параметров. Первый параметр должен быть виден на панели поиска расширения сообщений. Параметр должен иметь хорошее описание, которое должно содержать сочетание допустимых параметров, перечислений, сокращений и формата вывода.
Свойство semanticDescription используется для предоставления подробного описания команды для Microsoft 365 Copilot. Семантическое описание параметров поддерживает до 2000 символов и не отображается в пользовательском интерфейсе.
semanticDescription Если свойство остается пустым, Microsoft 365 Copilot использует сведения в description поле . При написании semanticDescriptionнеобходимо включить сведения об ожидаемых значениях, ограничениях и диапазонах для команды .
Хорошее описание параметра объясняет требования к системе на естественном языке с форматом вывода. Ниже приведено несколько примеров базовых и расширенных поисковых запросов для каждой категории.
-
Базовый поиск: поиск задач, связанных с Northwind.
- Расширенный поиск: поиск высокоприоритетных задач, связанных с Northwind, которые должны быть запланированы завтра.
Пример описания параметра:
"parameters": [
{
"name": "Name",
"title": "Project or Task Name",
"description": "Project name or task name as keyword.",
"inputType": "text"
},
{
"name": "Time",
"title": "Time",
"description": "Date or number of days for which you need tasks for.",
"semanticDescription": "Date or number of days for which you need tasks for. Output: Number",
"inputType": "text"
},
{
"name": "Priority",
"title": "Priority",
"description": "Priority of tasks.",
"semanticDescription": "Priority of tasks. Acceptable values are high, medium, low, NA",
"inputType": "text"
}]
Расширение расширения сообщений для получения информации с помощью составных речевых фрагментов
[Необходимо исправить]
Примечание.
Поиск в диалоговом окне (в TeamsJS версии 1.x называется модулем задач) не поддерживается в Microsoft 365 Copilot.
Для Microsoft 365 Copilot расширение сообщений на основе поиска должно поддерживать более трех уникальных составных речевых фрагментов для глубокого получения точной информации. Чтобы включить составные речевые фрагменты, необходимо развернуть область поиска для обработки трех или более параметров, обновив манифест приложения (ранее — манифест приложения Teams) и обеспечить следующее:
Обновите веб-службу для поддержки поиска на основе нескольких параметров. Дополнительные сведения о том, как реагировать на запросы пользователей, см. в разделе Ответить на команду поиска.
Microsoft 365 Copilot может передавать пустую строку или значение NULL для параметров, которые не являются частью пользовательского высказывания. Обновите веб-службу для обработки параметров.
Расширение сообщений поддерживает до 10 команд (9 доступных для использования), и каждая команда имеет соответствующее
parametersсвойство, которое поддерживает до пяти параметров.
Следующий код является примером нескольких параметров, определенных в манифесте приложения:
"commands": [
{
"id": "inventorySearch",
"context": [
"compose",
"commandBox"
],
"description": "Search products by name, category, inventory status, supplier location, stock level",
"title": "Product inventory",
"type": "query",
"parameters": [
{
"name": "productName",
"title": "Product name",
"description": "Enter a product name here",
"inputType": "text"
},
{
"name": "categoryName",
"title": "Category name",
"description": "Enter the category of the product",
"inputType": "text"
},
{
"name": "inventoryStatus",
"title": "Inventory status",
"description": "Enter what status of the product inventory. Possible values are 'in stock', 'low stock', 'on order', or 'out of stock'",
"inputType": "text"
},
{
"name": "supplierCity",
"title": "Supplier city",
"description": "Enter the supplier city of product",
"inputType": "text"
},
{
"name": "stockQuery",
"title": "Stock level",
"description": "Enter a range of integers such as 0-42 or 100- (for >100 items). Only use if you need an exact numeric range.",
"inputType": "text"
}
]
},
{
"id": "discountSearch",
"context": [
"compose",
"commandBox"
],
"description": "Search for discounted products by category",
"title": "Discounts",
"type": "query",
"parameters": [
{
"name": "categoryName",
"title": "Category name",
"description": "Enter the category to find discounted products",
"inputType": "text"
}
]
},
{
"id": "revenueSearch",
"context": [
"compose",
"commandBox"
],
"description": "Find products based on their revenue/period",
"title": "Revenue",
"type": "query",
"parameters": [
{
"name": "revenueRange",
"title": "Revenue range",
"description": "Enter 'high' or 'low' or enter a range of integers such as 0-10000 or 5000- using this exact format",
"inputType": "text"
}
]
}
]
Параметры поиска должны иметь хорошее описание с допустимыми параметрами, перечислениями, сокращениями и форматом вывода. Дополнительные сведения и примеры см. в описании параметра.
Определение примеров запросов
[Необходимо исправить]
Свойство samplePrompts содержит инструкции по использованию различных подключаемых модулей в Microsoft 365 Copilot. Microsoft 365 Copilot использует примеры запросов для отображения запросов для пользователя. Запросы должны быть адаптированы к разным языковым стандартом и понятны для разных команд. Примеры запросов доступны для первого запуска (FRE) в Microsoft 365 Copilot, когда пользователь впервые устанавливает или включает подключаемый модуль.
Примечание.
- Если в манифесте приложения не указано
samplePromptsсвойство, запросы не отображаются. - Свойство
samplePromptsявляется обязательным для проверки приложения во время отправки приложения. - При определении нескольких команд для приложения пользователю отображается не более трех запросов (по одному из трех первых команд). Запросы сменяются, чтобы предоставить пользователю разнообразный набор запросов в разных командах.
Следующий код является примером свойства в манифесте samplePrompts приложения:
"composeExtensions": [
{
"canUpdateConfiguration": true,
"botId": "bxxxxxx5-xxxx-xxxx-xxxx-4xxxxxx16599",
"commands": [
{
"id": "orders",
"title": "Orders",
"context": [
"Commandbox",
"Compose"
],
"description": "Search for orders",
"semanticDescription": "Search for orders",
"samplePrompts": [
{
"text": "Search for all orders"
},
{
"text": "Search for orders related to Contoso"
},
{
"text": "Search for all pending orders"
},
{
"text": "Search for all completed ordered for Fabrikam"
}
]
}
]
}
]
Создание многофункциональных ответов адаптивной карточки
[Необходимо исправить]
Расширения сообщений реагируют на ввод пользователем адаптивной карточки. Адаптивная карточка для подключаемого модуля расширения сообщений должна эффективно функционировать, многофункционально и соответствовать следующим требованиям:
Ответ адаптивной карточки должен включать содержимое адаптивной карточки и предварительный просмотр карта сведения в рамках одного шаблона. [Необходимо исправить]
Пример шаблона ответа адаптивной карточки
{ "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.5", "body": [ { "type": "Container", "items": [ { "type": "TextBlock", "text": "${companyName}", "size": "Medium", "wrap": true, "style": "heading" }, { "type": "TextBlock", "text": "${stockExchange} ${stockSymbol}", "isSubtle": true, "spacing": "None", "wrap": true }, { "type": "TextBlock", "text": "${formattedDate} ${formattedTime}", "wrap": true } ] }, { "type": "Container", "spacing": "None", "items": [ { "type": "ColumnSet", "columns": [ { "type": "Column", "width": "stretch", "items": [ { "type": "TextBlock", "text": "${currentPrice} ", "size": "ExtraLarge", "wrap": true }, { "type": "TextBlock", "text": "${priceChange} ${percentChange}", "color": "${changeColor}", "spacing": "None", "wrap": true } ] }, { "type": "Column", "width": "auto", "items": [ { "type": "FactSet", "facts": [ { "title": "Open", "value": "${openPrice} " }, { "title": "High", "value": "${highPrice} " }, { "title": "Low", "value": "${lowPrice} " } ] } ] } ] } ] } ], "previewCard": { "contentType": "application/vnd.microsoft.card.hero", "content": { "title": "${companyName}", "text": "${stockSymbol}" } } }Примечание.
Типы
imBackдействий иmessageBackне поддерживаются в объекте данных.Рекомендуется использовать следующие типы действий:
-
Action.OpenUrl: открывает указанный URL-адрес из карта. -
Action.ToggleVisibility: отображает или скрывает один или несколько элементов в карта. -
Action.Execute: собирает поля ввода и отправляет их в качестве запроса в службу бота. -
Action.Submit: открывает диалоговое окно или представление стадии с помощью вызова типа в объекте данных.
-
Если пользователь может изменить сведения о карта с помощью диалогового окна, stageview или непосредственно из карта, рекомендуется, чтобы адаптивная карточка поддерживала универсальные действия и автоматическое обновление. [Рекомендуется]
Адаптивные карточки должны содержать URL-адрес в составе метаданных, что позволяет легко копировать карточки из одного концентратора в другой. [Рекомендуется]
Помимо эскизов, любое изображение в адаптивной карточке должно иметь замещающий текст. [Рекомендуется]
Подключаемые модули расширения сообщений в приложениях Microsoft 365 Copilot
[Необходимо исправить]
Важно!
Подключаемые модули расширения сообщений в приложениях Microsoft 365 Copilot доступны в ограниченной закрытой предварительной версии для Word и PowerPoint. Дополнительные сведения будут опубликованы после объявления общедоступной предварительной версии.
Агенты Copilot настраивают и расширяют возможности Microsoft 365 Copilot, предоставляя дополнительные навыки и знания в Microsoft 365 Copilot для персонализированного взаимодействия с пользователем. Используя подключаемые модули, которые являются подмножеством агентов Copilot, пользователи могут интегрировать дополнительные возможности в Microsoft 365 Copilot, взаимодействуя со сторонними приложениями, будь то для получения или изменения информации в этих приложениях. Например, подключаемые модули расширения сообщений упрощают поиск данных в других приложениях, чтобы Microsoft 365 Copilot могли представить их по запросу при активации подключаемого модуля.
Если вы разработали подключаемый модуль для Microsoft 365 Copilot в Teams или copilot.microsoft.com, вы уже знаете о преимуществах, которые он предоставляет пользователям в рамках рабочего процесса.
Примеры кода
| Название примера | Описание | TypeScript |
|---|---|---|
| Расширение сообщений инвентаризации Northwind | В этом примере показано, как использовать расширение сообщений Teams в качестве подключаемого модуля в Microsoft 365 Copilot. | Просмотр |
См. также
Platform Docs