Use a classic chatbot as a skill in a Bot Framework bot

Raksts
04/03/2024

Note

This article includes information applicable to Microsoft Copilot Studio classic chatbots only. This feature is not available in the new Microsoft Copilot Studio experience.

When you use a Microsoft Copilot Studio copilot as a skill with a Bot Framework bot, the Bot Framework bot determines if anything the user says matches the Microsoft Copilot Studio copilot's trigger phrases. If there's a match, the Bot Framework bot passes the conversation to the Microsoft Copilot Studio bot. The Microsoft Copilot Studio copilot extracts any entities and triggers the matching topic.

You can also pass a variable to a Microsoft Copilot Studio skill topic as an input from Bot Framework Composer and use the outputs it returns.

Important

You must have a trial or full Microsoft Copilot Studio license to use Microsoft Copilot Studio bots as skills. This capability isn't available with the Teams Microsoft Copilot Studio license.

To set up your Microsoft Copilot Studio copilot as a skill:

Add the Bot Framework bot to the allowlist for the Microsoft Copilot Studio copilot.
Download the skill manifest for the Microsoft Copilot Studio copilot.
Use the downloaded skill manifest in Bot Framework Composer to create a connection between the bots.
Use the Bot Framework Emulator to confirm the bot works as a skill.

Prerequisites

Add your Bot Framework bot to the allowlist for your Microsoft Copilot Studio copilot

Add the Bot Framework bot's app ID to the allowlist for the Microsoft Copilot Studio copilot that you want to use as a skill. The bots must be in the same tenant.

In Bot Framework Composer, open the bot that will use the skill. Select Configure, and then select Development resources. Copy the ID in Microsoft App ID.
In Microsoft Copilot Studio, open the copilot you want to use as a skill.
In the navigation menu, go to Settings and select Security. Then select Allowlist.
Select Add allowed caller.
Paste your Bot Framework bot's app ID and select Next.

Caution

A Microsoft Copilot Studio copilot can't act as a skill for other Microsoft Copilot Studio copilots. If you try to add an app ID that belongs to a Power Virtual Agent bot to the allowlist, you'll get an error. You can only add an app ID for a Bot Framework bot.

Microsoft Copilot Studio validates the Bot Framework bot's app ID and confirms that it belongs to a bot in the same tenant.
(Optional) Add a Display name for the bot you've added to the allowlist.
Select Save.

The Bot Framework bot is shown by its display name if you entered one, or by its app ID if you didn't enter a display name. To delete or edit it at any time, select the icon to the right of the bot's display name or app ID.

Screenshot of the Manage allowlist panel showing the edit and delete icons for an allowed bot.

Note

Bot Framework bots added to the allowlist aren't exported as part of the bot content.

Download the copilot skill manifest for your Microsoft Copilot Studio copilot

Bot Framework bots can use a Microsoft Copilot Studio skill manifest to configure a connection to the copilot that produced the manifest.

All Microsoft Copilot Studio copilots have skill manifests. These are JSON files that include a skill's name, interface, and trigger phrases.

A Bot Framework bot can use a skill manifest to know when to trigger the Microsoft Copilot Studio bot (for example, in response to something a user says to it).

Microsoft Copilot Studio skill manifests follow version 2.2 of the Bot Framework skill manifest schema and consist of intents.lu and manifest.json files.

A Bot Framework bot may decide a Microsoft Copilot Studio copilot should handle the user's request, based on the manifest data. It passes to the copilot everything the user said. Then, the Microsoft Copilot Studio copilot matches what the user said to a Microsoft Copilot Studio topic, extracts any entities that are needed for slot-filling, and triggers the Microsoft Copilot Studio topic.

Microsoft Copilot Studio skill manifests are automatically generated and updated. A Microsoft Copilot Studio copilot has two skill manifests:

Test manifest: Allows the Bot Framework bot to connect to the test version of your Microsoft Copilot Studio copilot. Use the test manifest to validate changes to your skill before you publish it.
- The test manifest is immediately available for every newly created Microsoft Copilot Studio bot.
- It's automatically updated to reflect changes every time you save your copilot.
Published manifest: Allows the Bot Framework bot to connect to the published version of your Microsoft Copilot Studio copilot.
- The published manifest is only available for Microsoft Copilot Studio copilots that have been published at least once.
- It's automatically updated to reflect changes every time you publish your copilot.

Note

The Published manifest isn't available for Microsoft Copilot Studio copilots that have never been published.

To generate your bot's Published manifest, publish your Microsoft Copilot Studio copilot.

Both skill manifests are shown on the Manage allowlist panel.

Screenshot of the Manage allowlist panel showing the Microsoft Copilot Studio copilot manifests.

The skill manifests are also shown on the copilot's Details page. In the navigation menu, select Settings, and then select Details. The Details page shows other metadata, including Environment ID, Tenant ID, and Bot app ID.

Screenshot of the Details page highlighting where to download the Microsoft Copilot Studio copilot manifests.

To download a manifest, select it. It downloads as a .zip file labeled <bot name>_manifest for the Published manifest, or <bot name>_test__manifest for the Test manifest.

Screenshot showing the two Microsoft Copilot Studio manifests after they've been downloaded.

Note

The skill manifest doesn't include system topics and Composer dialogs that are added to a Microsoft Copilot Studio copilot. Only topics that were created by copilot authors and Composer intent triggers that authors add to the bot are included.

Connect to a Microsoft Copilot Studio skill in Composer

Use Microsoft Copilot Studio skill manifests to create a skill connection in your Bot Framework bot in Composer.

In a Bot Framework Composer project, select Add, and then select Connect to a skill.
Browse to and select a Microsoft Copilot Studio manifest .zip archive, and then select Next.
Select the topics, or intents, in your Microsoft Copilot Studio copilot that you want to add to your Bot Framework bot, and then select Next.
Review and edit the trigger phrases for your Microsoft Copilot Studio copilot, and then select Next.
Make sure Use Orchestrator for multi-bot projects is selected, and then select Continue.
Verify that the Microsoft Copilot Studio skill is added to your Bot Framework bot correctly, and that a new trigger with your Microsoft Copilot Studio copilot's name appears in the project in Composer.

Locate the topic in the skill manifest

Use an event to trigger a Microsoft Copilot Studio topic in the skill. To call a specific topic from Composer, refer to the topic by the name of the associated event in the skill manifest.

Select the Connect to a skill action.
Under Skill Dialog Name, select Show skill manifest.
Find activities in the manifest. This property contains nested properties that represent the topics available in your Microsoft Copilot Studio copilot.
Find the topic you want to call and look for its name property. When the Microsoft Copilot Studio skill receives an event with this name, it triggers the topic.

In the following example, the event activity name is dispatchTo_new_topic_87609dabd86049f7bc6507c6f7263aba_33d.

Call a Microsoft Copilot Studio skill topic

Instead of relying on what a user says to trigger a Microsoft Copilot Studio skill topic, you can call it directly. You can only directly call Microsoft Copilot Studio topics that are listed in the skill manifest.

In the Composer authoring canvas, select Add, then select Access external resources, and then select Connect to a skill.
In the Skill Dialog Name list, select your Microsoft Copilot Studio copilot.
Find the event activity's name for the Microsoft Copilot Studio bot topic that you want to call. Copy the value, omitting the quotation marks, and save it to use in the next steps.
Select Close.
In the Activity section, select Show code.
Type or paste the following code. Replace TOPIC_ACTIVITY_NAME with your topic's event activity name. Make sure there are no quotation marks in the name property.
```
[Activity
    type = event
    name = TOPIC_ACTIVITY_NAME
]
```

Pass an input variable to a Microsoft Copilot Studio skill topic

Bot Framework Composer can pass a variable to a Microsoft Copilot Studio skill topic as an input. To learn how to create Microsoft Copilot Studio topics that accept input variables, see Work with variables.

If a Microsoft Copilot Studio topic that can receive an input variable is listed in your skill manifest, you can pass a Composer variable to it.

In the Composer authoring canvas, select Add, then select Access external resources, and then select Connect to a skill.
In the Skill Dialog Name list, select your Microsoft Copilot Studio copilot.
Find the event activity's name for the Microsoft Copilot Studio copilot topic that you want to call. Copy the value, omitting the quotation marks, and save it to use in the next steps.
Find the topic's value property. The value property contains a $ref property. Copy that value and save it to use in the next step.

Warning

If a Microsoft Copilot Studio topic doesn't have inputs, it won't have a value property.
Find the definitions property, then look for a nested property that matches the $ref value you found in the previous step. Note the names and types of the Microsoft Copilot Studio topic's inputs. You'll use them in the next steps.
Select Close.
Under the Activity section, select Show code.
Type or paste the following code. Replace these values:
1. Replace TOPIC_ACTIVITY_NAME with your topic's event activity name.
2. Replace PVA_INPUT_VARIABLE with an input variable from your topic.
3. Replace COMPOSER_INPUT_VARIABLE with a Composer variable that will provide a value.
```
[Activity
    Type = event
    Name = TOPIC_ACTIVITY_NAME
    Value = ${addProperty(json("{}"), 'PVA_INPUT_VARIABLE', COMPOSER_INPUT_VARIABLE)}
]
```
In the following the example, the Composer variable dialog.storeLocation provides a value to the input variable pva_StoreLocation in the Microsoft Copilot Studio copilot topic dispatchTo_new_topic_127cdcdbbb4a480ea113c5101f309089_21a34f16.

Receive an output variable from a Microsoft Copilot Studio skill topic

It's possible to receive outputs from a Microsoft Copilot Studio skill topic in Composer. To learn how to create Microsoft Copilot Studio topics that return outputs, see Work with variables.

In the Composer authoring canvas, select Add, then select Access external resources, and then select Connect to a skill.
In the Skill Dialog Name list, select your Microsoft Copilot Studio copilot.
Find the event activity's name for your Microsoft Copilot Studio bot topic you want to call. Copy the value, omitting the quotation marks, and save it to use in the next steps.
Find the topic's resultValue property. The resultValue property contains a $ref property. Copy that value and save it to use in the next step.

Warning

If a Microsoft Copilot Studio topic doesn't have outputs, it won't have a resultValue property.
Find the definitions property, then look for a nested property that matches the $ref value you found in the previous step. Note the names and types of the Microsoft Copilot Studio topic's output variables. You'll use them in the next steps.

In the following example, the Microsoft Copilot Studio topic returns two outputs of type String, pva_State and pva_Item.
Select Close.
In the Activity section, select Show code.
Type or paste the following code. Replace TOPIC_ACTIVITY_NAME with your topic's event activity name. Make sure there are no quotation marks in the name property.
```
[Activity
    type = event
    name = TOPIC_ACTIVITY_NAME
]
```
Under the code area, set Property to a Composer variable to receive and store the output values from the Microsoft Copilot Studio skill topic.
In the Composer authoring canvas, select Add, then select Manage properties, and then select Set properties.
Set Property to the Composer value that should store the extracted value. Then set Value to the Composer variable you stored the topic's outputs in.

In the following example, the output values from dialog.skillResult.pvaState and dialog.skillResult.pvaItem are extracted into new Composer variables dialog.State and dialog.Item.