Adding Copilot Studio Client API and SPA Sample

[svandenhoven]

Description

The Copilot Studio Client API and SPA Sample is an example application that demonstrates how a user can log in with their Entra ID account on a Single Page Application (SPA) built with React. This application utilizes a .NET API that leverages the Microsoft 365 Agents SDK. Through this setup, the API can interact with any Copilot Studio Agent, enabling the creation of conversations that can be accessed via a React SPA.

Architecture

graph TD

    A[React SPA] -->|1 Login| F[Entra ID]
    F -->|2 Access Token| A
    A -->|3 API Request with Access Token| B[Custom API]
    B -->|4 Request Access Token on behalf of user| F
    F -->|5 Access Token| B
    B -->|6 API Request with Access Token| C[CopilotStudio API]
    C -->|13 API Response| B
    B -->|14 API Response| A
    C -->|7 Call Agent| G[Copilot Agent]
    G -->|12 Agent Response| C

    G -.->|8 Query| D[Search Index]
    D -.->|9 Response| G
    G -.->|10 Query| E[OpenAI]
    E -.->|11 Response| G

    subgraph Optional Components
        direction TB
        D[Search Index]
        E[OpenAI]
    end

Loading

To Test

See in the README.md in folder "copilot_studio_client_api_and_spa" how to configure the sample to test it.

Changes

This pull request introduces a new sample API project, CopilotStudioClientSampleAPI, which integrates with Microsoft Copilot Studio. The changes include adding new package dependencies, updating the solution file, and implementing the API's functionality.

New Sample API Project:

• Project Setup and Dependencies:

  • Added new package dependencies in Directory.Packages.props for Microsoft.AspNetCore.Authentication.OpenIdConnect, Microsoft.Identity.Web, Microsoft.Identity.Web.DownstreamApi, and Swashbuckle.AspNetCore.
  • Created a new project file CopilotStudioClientSampleAPI.csproj with references to necessary packages and project dependencies.
  • Added dotnet-tools.json to manage .NET tools for the project.

• Solution Configuration:

  • Updated Microsoft.Agents.SDK.sln to include the new CopilotStudioClientSampleAPI project. [1] [2] [3]

• API Implementation:

  • Implemented the Chat controller in Controllers/Chat.cs to handle chat interactions with Copilot Studio.
  • Added model classes Conversation, ChatResponse, MessageRequest, and Content in Models/ChatResponse.cs to structure API responses and requests.
  • Configured the API in Program.cs to set up services, authentication, and CORS policy.

• Documentation and Configuration:

  • Added a README.md file outlining the project architecture, setup instructions, and configuration details.
  • Included an HTTP request sample file CopilotStudioClientSampleAPI.http for testing the API endpoints.