Сценарии агента TypeSpec для Microsoft 365 Copilot

Совет

Рекомендуется: Начните с Work IQ Dev Tools для поддерживаемых сценариев декларативного агента и плагинов для кода. См. краткое руководство по WIQD. Инструкции на основе набора средств остаются доступными для существующих проектов и рабочих процессов, для которых они требуются. Перед выбором инструмента проверьте поддержку возможностей и целевого интерфейса : WIQD не нацелен на агентов пользовательской подсистемы.

В этом руководстве приводятся полные примеры создания агентов TypeSpec для Microsoft 365 Copilot, от простых базовых агентов до сложных реализаций с несколькими возможностями и методами проверки подлинности.

Базовый агент без функций

Пример использования: простой агент, предоставляющий базовую информацию и приветствие без каких-либо внешних интеграций или специальных возможностей.

Что он делает: этот агент может отвечать на простые вопросы, предоставлять общие сведения и вести базовые беседы. Ему не нужно получать доступ к внешним API, выполнять поиск в Интернете или получать доступ к данным Microsoft 365.

import "@typespec/http";
import "@typespec/openapi3";
import "@microsoft/typespec-m365-copilot";

using TypeSpec.Http;
using TypeSpec.M365.Copilot.Agents;

@agent("Basic Helper Agent", "A simple agent that provides basic information and assistance")
@instructions("""
  You are a helpful assistant that provides basic information and support.
  Be friendly, professional, and helpful in all interactions. Provide clear,
  concise answers to user questions. If you don't know something, be honest
  about your limitations and suggest alternative ways to find the information.
""")
namespace BasicHelperAgent {
  // No capabilities defined - agent relies only on built-in conversational abilities
}

Агент с несколькими возможностями

Пример использования: помощник работника умственного труда, который может искать информацию в Интернете, получать доступ к контенту SharePoint организации и находить информацию о коллегах в организации.

Что он делает: Этот агент помогает работникам умственного труда, объединяя поиск внешней информации в Интернете, доступ к файлам для поиска документов и поиск людей, чтобы найти коллег и их контактные данные. Этот шаблон подходит для сценариев исследований и совместной работы.

import "@typespec/http";
import "@typespec/openapi3";
import "@microsoft/typespec-m365-copilot";

using TypeSpec.Http;
using TypeSpec.M365.Copilot.Agents;

@agent("Knowledge Worker Assistant", "An intelligent assistant that helps with research, file management, and finding colleagues")
@instructions("""
  You are a knowledgeable research assistant specialized in helping knowledge workers
  find information efficiently. You can search the web for external research, access
  SharePoint documents for organizational content, and help locate colleagues within
  the organization. Always provide comprehensive research results, cite your sources,
  and suggest additional resources when relevant. When searching for people, respect
  privacy and only share publicly available organizational information.
""")
namespace KnowledgeWorkerAgent {
  // Web search capability for external research
  op webSearch is AgentCapabilities.WebSearch<Sites = [
    {
      url: "https://learn.microsoft.com";
    },
    {
      url: "https://www.microsoft.com";
    }
  ]>;

  // OneDrive and SharePoint access for document retrieval
  op oneDriveAndSharePoint is AgentCapabilities.OneDriveAndSharePoint<
    ItemsByUrl = [
      { url: "https://contoso.sharepoint.com/sites/IT" }
    ]
  >;

  // People search for finding colleagues
  op people is AgentCapabilities.People;
}

Простой агент с анонимным действием API

Пример использования: агент управления объектами, который помогает пользователям сообщать о проблемах с обслуживанием и отслеживать их с помощью API общественного ремонта.

Что он делает: Этот агент позволяет пользователям сообщать о проблемах с оборудованием (неисправное оборудование, проблемы с освещением и т. д.) и проверка состояния существующих запросов на ремонт. API восстановления общедоступен и не требует проверки подлинности, что позволяет любому пользователю легко сообщать о проблемах.

import "@typespec/http";
import "@typespec/openapi3";
import "@microsoft/typespec-m365-copilot";
import "./actions.tsp";

using TypeSpec.Http;
using TypeSpec.M365.Copilot.Agents;
using TypeSpec.M365.Copilot.Actions;

@agent("Facilities Repair Agent", "Report and track facility maintenance issues and repair requests")
@instructions("""
  You are a facilities management assistant that helps employees report and track
  maintenance issues. You can help users submit new repair requests by gathering
  all necessary details (description, location, category, priority) and submit
  them to the facilities team. You can also check the status of existing repair
  tickets and provide updates on progress. Always be helpful in categorizing
  issues correctly and setting appropriate priority levels based on safety and
  business impact.
""")
namespace FacilitiesRepairAgent {
  op reportIssue is RepairsAPI.reportIssue;
  op getRepairStatus is RepairsAPI.getRepairStatus;
  op getOpenRepairs is RepairsAPI.getOpenRepairs;
}

Расширенный агент с проверкой подлинности по ключу API

Пример использования: агент управления ремонтом, который помогает командам отслеживать задачи обслуживания объекта и управлять ими с помощью общедоступного API с проверкой подлинности ключа API.

Что он делает: этот агент предоставляет комплексные возможности управления ремонтом для групп обслуживания. Он может перечислять, создавать, обновлять и удалять задачи восстановления, фильтровать результаты восстановления по исполнителю или описанию, а также предоставлять подробные ответы на основе карт с изображениями. Аутентификация API-ключа обеспечивает контролируемый доступ к системе управления ремонтом, демонстрируя реальные шаблоны интеграции API.

import "@typespec/http";
import "@typespec/openapi3";
import "@microsoft/typespec-m365-copilot";
import "./actions.tsp";

using TypeSpec.Http;
using TypeSpec.M365.Copilot.Agents;
using TypeSpec.M365.Copilot.Actions;

@agent("Repairs Hub Agent", "Smart repair management agent for tracking and coordinating facility maintenance tasks")
@instructions("""
  You are a specialized repairs management assistant that helps teams efficiently track,
  organize, and coordinate facility maintenance tasks. You excel at managing repair
  workflows including creating detailed repair tickets, assigning tasks to team members,
  tracking progress, and providing status updates. You can filter repairs by various
  criteria such as assignee, keywords in descriptions, or completion status. Always
  provide clear, organized information using tables and cards when displaying repair
  data. When creating repairs, gather all necessary details and confirm the information
  before submission. Help prioritize urgent repairs and ensure proper task assignment
  for optimal team productivity.
""")
@conversationStarter(#{
  title: "List repairs",
  text: "List all repairs"
})
@conversationStarter(#{
  title: "List Karin's repairs",
  text: "List all repairs assigned to Karin"
})
@conversationStarter(#{
  title: "Find oil repairs",
  text: "List all repairs that are about oil"
})
@conversationStarter(#{
  title: "Create repair",
  text: "Create a new repair and assign it to me"
})
namespace RepairsAgent {
  // Repair management operations
  op listRepairs is RepairsHub.listRepairs;
  op createRepair is RepairsHub.createRepair;
  op updateRepair is RepairsHub.updateRepair;
  op deleteRepair is RepairsHub.deleteRepair;
}

Комплексный агент с интеграцией OAuth2 и API GitHub

Пример использования: Агент управления проектами, который помогает командам разработчиков управлять своими репозиториями GitHub, отслеживать проблемы, управлять запросами на вытягивание и координировать действия над проектами с помощью комплексного API GitHub.

Задачи. Этот агент выступает в качестве помощника по управлению проектами, который интегрируется с GitHub, помогая командам разработчиков оптимизировать свои рабочие процессы. Он может создавать проблемы и управлять ими, просматривать и объединять запросы на вытягивание, отслеживать вехи проектов и предоставлять аналитические сведения о деятельности репозитория. Проверка подлинности OAuth2 обеспечивает безопасный доступ к репозиториям GitHub с соответствующими разрешениями, позволяя командам эффективно управлять своими проектами за счет взаимодействия на естественном языке.

import "@typespec/http";
import "@typespec/openapi3";
import "@microsoft/typespec-m365-copilot";
import "./actions.tsp";

using TypeSpec.Http;
using TypeSpec.M365.Copilot.Agents;
using TypeSpec.M365.Copilot.Actions;

@agent("GitHub Project Manager", "Smart project management agent with GitHub integration for issue tracking, pull request management, and project coordination")
@instructions("""
  You are an intelligent project management assistant specialized in GitHub workflows
  and development team coordination. You excel at managing GitHub repositories including
  creating and tracking issues, reviewing pull requests, coordinating project milestones,
  and providing insights about development activity. You can help prioritize work,
  track progress, manage code reviews, and facilitate team collaboration through GitHub's
  project management features. Always consider development best practices, help maintain
  code quality through proper review processes, and provide actionable insights to
  improve team productivity and project delivery.
""")
namespace GitHubProjectManager {
  // GitHub API operations for project management
  op createIssue is GitHubAPI.createIssue;
  op getIssues is GitHubAPI.getIssues;
  op updateIssue is GitHubAPI.updateIssue;
  op getPullRequests is GitHubAPI.getPullRequests;
  op createPullRequest is GitHubAPI.createPullRequest;
  op mergePullRequest is GitHubAPI.mergePullRequest;
  op getProjectInsights is GitHubAPI.getProjectInsights;
}

Сводка

Эти примеры демонстрируют переход от простых к сложным агентам TypeSpec:

Каждый пример основан на предыдущих, показывая, как добавлять возможности, проверку подлинности и настраиваемые действия для создания более сложных агентов для реальных сценариев.