Extend Microsoft Copilot with connector action (preview) – Microsoft Copilot Studio


Connector actions let you define connectors that can be invoked from AI surfaces in Power Platform. For connector actions, you need to identify the actions enabled for use in the Copilot. You can also capture the information that large language models require to effectively identify and utilize the plugin, such as summary and description fields.

Prerequisites

A few prerequisites are needed in order to extend Microsoft-branded copilot experiences with connector actions.

General prerequisites

For all Copilot types, you must have maker-level credentials, a copilot license, and a Microsoft Teams license.

Dynamics 365 Customer Service and Copilot for Sales prerequisites

For Copilot for Dynamic 365 Customer Service and Copilot for Sales, you must be logged into an environment that contains the Copilot that you wish to extend.

Copilot for Sales prerequisites

  • Salesforce customers need to be logged into their Dataverse environment (The environment is usually named msdyn_viva).
  • You need to log into Copilot for Sales through Outlook in the environment you wish to extend at least once before extending.

Add a connector action

Adding a connector action to a Microsoft-branded copilot involves a few steps. The following sections provide guidance on how to add a connector action to Copilot for Microsoft 365, Copilot for Sales, and Copilot for Dynamics 365 Customer Service.

Select the Copilot experience and choose connector action

  1. On the home page, select Copilots.


    Open copilots list

  2. On the Copilots list in the left hand navigation, select the Microsoft-branded copilot experience you wish to extend.


    Select Copilot for Microsoft 365

    The overview page for the Copilot is displayed.


    View Copilot for Microsoft 365

  3. Depending on the Copilot you selected, select either the Actions or Extensions tab. You can see a list of the actions already present within the Copilot.

  4. Next, select to extend the Copilot with an action.

    For Copilot for Microsoft 365, select Add Extension, and then select New action.

    For other Copilot types, select Add Action.


    Copilot for Microsoft 365 add extension

    You’re provided a list of all supported action types for the Copilot.


    Choose new action type for Copilot for Microsoft 365

  5. Select Connector to extend with a connector action.

    The Select your connector page is displayed. You’re provided a list of available connector types to select from.

    Connectors connect copilots to different services. The list includes all certified connectors offered by Microsoft.

    Depending on the Copilot, the list may also include any custom connectors that are present in the current environment being used. A search bar is available to help find the connector that you wish to use.

    Note

    At this time, custom connectors cannot be used to extend Copilot for Sales or Copilot for Dynamics 365 Customer Service.

Select connector type and select a solution

  1. Find your connector type using the search bar and select it.


    Choose connector type

    The Build a custom AI action using your connector page is displayed.

  2. Write a name and description for your connector.

    The connector name must be unique. By default, it takes on the name of the connector type that was chosen. You should add more defining information to ensure it’s both a unique name and that it’s easy to discern what it does for users who want to enable it later. Consider including in the description the types of actions it allows like “Mail service allows you to retrieve and create messages.”


    Configure connector basic information

    The description may be provided if present in the connector you selected. The description is used by the Copilot to identify when the action can be used to get responses back for the user request. Make the description as detailed and descriptive as you can. Provide specific details using terms you expect users to use when calling on the action. To continue with the mail service example, you may include something like:

    “Mail service provides the ability to get lists of existing messages, retrieve folders where messages are stored, list titles of messages and folders, get messages, update message titles and bodies, and set priority for messages.”

    The description lets the Copilot know to use the action without being explicitly instructed, allowing for a more natural language experience.

  3. Under Solution, a dropdown lists all solutions available within the current environment. Select the solution you want to use. For more information on what solutions are, and why they benefit you, see Solution concepts.


    Select solution

    If you have a preferred solution, or your selected connector is already in the solution, that solution is autoselected. You can either select a solution, or leave it blank. If you leave the solution blank, a solution is created for you with action name and default publisher. Storing your action in a solution lets you move it easily across environments.

    Note

    You do not see default solution or CDS default solution as an option in this case as we recommend having a custom solution for easy management. For more information, see: Default solution vs. custom solution.

  4. Choose a solution and select Next.

    The Select and configure your plugin action page is displayed. This page shows all the actions that are available to add for your connector. You can select and configure any actions you want your copilot to support, one at a time. A search bar is included to help you find the action you wish to select. There’s no limit to the number of actions you can select for the connector.


    Add action to connector

Add actions to the connector

Next, you need to select from the available actions to add to the connector.

Note

Connectors can only execute the actions you specifically select and configure here. If an action isn’t listed, then it’s not available. It’s not possible to add or remove actions from a connector from within the Copilot Studio actions wizard.

  1. Select an action to proceed. The Configure your plugin action page is displayed for that chosen action.


    Connector configure added action

  2. Provide a name and description for your action. The name doesn’t have to be unique in this case. These values are most likely going to be populated for you from the connector. However, as with the connector description, you should provide a detailed specific description so that the copilot knows when to invoke the specific action. The description helps allow a more natural language approach to selecting the action to execute. For example, if an action is “List message folders,” you might use:

    “List message folders allows you to get a list of all message folders available from the mail service. This action retrieves all folders, places them into a list view, and returns them to you.”

    The action description provides the context clues “list message folders,” “get,” “all,” “retrieve,” “list,” “mail service,” “return,” “folders,” and “view.” Your copilot can use these context clues to identify when the action is the right one for a user request.

  3. After you complete the page, select Next. The Review your action’s parameters page is displayed.

  4. Select Next to proceed.

    You’re returned to the Select and configure your plugin action page you were on before. You can see the new action you selected.


    Connector select action screen first action selected

  5. Select another action and repeat the previous action configuration steps if desired.

    Alternatively, select Next. The Review, test, and publish your action screen is displayed.


    Review, test and publish the connector

    The Review, test and publish your action page displays the details of all of the configuration steps up to this point. You can review them, and then test your action before publishing.

Test

With your connector action configured, you can now test it.

Note

At this time Copilot in Dynamics 365 for Customer Service does not allow for testing from inside of the connector actiion creation wizard. When this feature becomes available you will be able to test the plugin from this screen. For now users must publish the plugin and then they can validate it is functional within the Copilot in Dynamics 365 for Customer Service directly after it is enabled by an administrator.

  1. Select your existing connection from the dropdown or select + New connection if you don’t have a connection.

    If you select + New connection, a wizard opens where you can add details to build the connection. When you’re done, you can select the new connection from the dropdown.

  2. When you’re done selecting a connection, select Test action.

  3. When you see a message that the action is ready to test, select Open to test to open the Copilot chat in a new window. Open the flyout to see the action, and toggle it on.

    The action appears with a beaker icon under the connector chosen with format Test-Action name.

  4. You can now test the plugin by trying the prompts you expect a user to use. You can also use the –developer on command to get more information on prompt execution. Once you’re satisfied with the results, return to the Copilot Studio window.

Publish

  1. Once you’re done testing, select Publish.

    A page is displayed showing your connector in the process of being published. Once completed, you see a page indicating that your connector is published.

  2. Select Go To Details Page to see the details of the published plugin.

    Note

    Now that your connector is published an administrator must enable it before it can be used in the copilot.

  3. You can also easily move a connector from one environment to another using a solution. To do so select Export solution on the details page. Exporting the solution lets you export the connector.


    Export solution

  4. Change the version number if needed and select if the solution must be Managed or Unmanaged.

    • Managed means you don’t expect to have to make further changes to the solution.
    • Unmanaged means you want to make changes to the solution in the target environment.
  5. On completion, you see a green message with option to Download the solution, which saves a .zip file in your system.

    Note

    You aren’t required to select Publish in the solutions panel.

  6. Return to the Copilot Actions/Extensions page in Copilot Studio and select Import Solution in the target environment.

    Import solution

  7. Browse to select the .zip file for your exported solution and select Next to proceed. You can see the connector appearing in the Actions/Extensions list.



Source link

Leave a Comment