Microsoft.Agents.CopilotStudio.Client 0.2.171-alpha

Microsoft.Agents.CopilotStudio.Client

Provides a client to interact with agents built in Copilot Studio. This Library is intended to provide access to a given agent's conversational channel.

Instructions - Required Setup to use this library

Prerequisite

To use this library, you will need the following:

1. An Agent Created in Microsoft Copilot Studio.
2. Ability to Create a Application Identity in Azure for a Public Client/Native App Registration Or access to an existing Public Client/Native App registration with the CopilotStudio.Copilot.Invoke API Permission assigned.

Create a Agent in Copilot Studio

1. Create or open an Agent in Copilot Studio
   1. Make sure that the Copilot is Published
   2. Goto Settings ⇒ Advanced ⇒ Metadata and copy the following values, You will need them later:
      1. Schema name - this is the 'unique name' of your agent inside this environment.
      2. Environment Id - this is the ID of the environment that contains the agent.

Create an Application Registration in Entra ID to support user authentication to Copilot Studio

This is used when you are creating an application soly for the purpose of user interactive login and will be using a client that will surface an Entra ID MultiFactor Authentication Prompt.

[!IMPORTANT] If you are using this client from a service, you will need to exchange the user token used to login to your service for a token for your agent hosted in copilot studio. This is called a On Behalf Of authentication token. You can find more information about this authentication flow in Entra Documentation.

This step will require permissions to Create application identities in your Azure tenant. For user authentication, you will be creating a Native Client Application Identity, which does not have secrets.

1. Open https://portal.azure.com
2. Navigate to Entra Id
3. Create an new App Registration in Entra ID
   1. Provide an Name
   2. Choose "Accounts in this organization directory only"
   3. In the "Select a Platform" list, Choose "Public Client/native (mobile & desktop)
   4. In the Redirect URI url box, type in http://localhost (note: use HTTP, not HTTPS)
   5. Then click register.
4. In your newly created application
   1. On the Overview page, Note down for use later when configuring the example application:
      1. the Application (client) ID
      2. the Directory (tenant) ID
   2. Goto Manage
   3. Goto API Permissions
   4. Click Add Permission
      1. In the side pannel that appears, Click the tab API's my organization uses
      2. Search for Power Platform API.
         1. If you do not see Power Platform API see the note at the bottom of this section.
      3. In the permissions list choose CopilotStudio and Check CopilotStudio.Copilots.Invoke
      4. Click Add Permissions
   5. (Optional) Click Grant Admin consent for copilotsdk
   6. Close Azure Portal

[!TIP] If you do not see Power Platform API in the list of API's your organization uses, you need to add the Power Platform API to your tenant. To do that, goto Power Platform API Authentication and follow the instructions on Step 2 to add the Power Platform Admin API to your Tenant

Add the CopilotStudio.Copilots.Invoke permissions to your Application Registration in Entra ID to support user authentication to Copilot Studio

How-to use

User Based auth flows

User based authentication flows are the only currently supported flow for this client.

Your code will need to create a User Token ( via MSAL Public Client or an OBO flow for a User access token) to call this service.

There are currently two ways to pass auth to the CopilotClient.

1. Create an HttpMessageRequest Handler that will populate the bearer token and assign it to the httpClient you create

In this case, you would create an HttpMessageRequestHandler that creates the bearer header on the http request message, In the example below, AddTokenHandler is responsible for adding the bearer header to the http request prior to the send:

// Create an http client for use by the DirectToEngine Client and add the token handler to the client.
builder.Services.AddHttpClient("mcs").ConfigurePrimaryHttpMessageHandler(
    () => new AddTokenHandler(settings));

Then create an instance the client and request to start a conversation:

var copilotClient = new CopilotClient(settings, s.GetRequiredService<IHttpClientFactory>(), logger, "mcs");
await foreach (Activity act in copilotClient.StartConversationAsync(emitStartConversationEvent:true, cancellationToken:cancellationToken))
{

}

2. Create a function that returns a user token and pass that to the constructor for the Copilot Client

In this case, the TokenService is a class is responsible for managing the token acquire flow and returning the access token via the GetToken API call on the TokenService Class.

[!NOTE] We do not cover how to create the TokenService Class in this document. The Copilot client is looking for a function that matches the signature Func<string, Task<string>> tokenProviderFunction

var tokenService = new TokenService(settings);
var copilotClient = new CopilotClient(settings, s.GetRequiredService<IHttpClientFactory>(), tokenService.GetToken, logger, "mcs");

await foreach (Activity act in copilotClient.StartConversationAsync(emitStartConversationEvent:true, cancellationToken:cancellationToken))
{

}