|
| 1 | +--- |
| 2 | +title: SharePoint Embedded agent |
| 3 | +description: Details usage and billing for SharePoint Embedded agents |
| 4 | +ms.date: 05/12/2025 |
| 5 | +ms.localizationpriority: high |
| 6 | +--- |
| 7 | + |
| 8 | +# Overview |
| 9 | + |
| 10 | +> [!NOTE] |
| 11 | +> |
| 12 | +> SharePoint Embedded agent is currently in private preview. Stay tuned for latest API and SDK changes on this page. |
| 13 | +> |
| 14 | +> SPE agent consumption-based model will be available in May 2025! Starting May 1st, standard billing model will be available to all private preview customers and this rollout is expected to complete by May 15th. This means that starting May 15th, to use SPE agent within an SPE application, you will need to use standard Container Type. SPE Agent interactions, including those from Microsoft 365 Copilot license users, will be billed to the Azure subscription associated with your Container Type. Learn more about [SharePoint Embedded billing management](/sharepoint/dev/embedded/administration/billing/billingmanagement). |
| 15 | +> |
| 16 | +> We are actively working on enabling Direct-to-Customer billing model for SPE agent. Stay tuned for more announcements. |
| 17 | +
|
| 18 | +SharePoint Embedded agent enables you to add AI capabilities into your application through a simple SDK. This chat control offers the following features: |
| 19 | + |
| 20 | +- Reason over documents in SharePoint Embedded containers using RAG. |
| 21 | +- Developers can configure the application code to limit the search scope to files, folders, and containers. |
| 22 | +- Developers can customize and configure chat control including starter prompts, suggested prompts, colors and more. |
| 23 | + |
| 24 | +Watch this demo to learn more about how to configure this functionality. |
| 25 | + |
| 26 | +> [!VIDEO https://www.youtube.com/embed/30i7q09EtQo?si=MwLtbrGKnzv7a6My] |
| 27 | +
|
| 28 | +## Why use SharePoint Embedded agent |
| 29 | + |
| 30 | +SharePoint Embedded agent harness a semantic index to power Retrieval-Augmented Generation (RAG), securely referencing your data within the Microsoft 365 boundary at query time. This ensures accurate, grounded AI responses while reducing reliance on broad knowledge models. A pay-as-you-go billing model is on the horizon, aligning costs with actual usage. |
| 31 | + |
| 32 | + |
| 33 | + |
| 34 | +## How to use SharePoint Embedded agent |
| 35 | + |
| 36 | +### How to build your agent |
| 37 | + |
| 38 | +Currently, you can use the React SDK library written in TypeScript to build your application. Plans to support additional frameworks and environments will be announced. The SDK is configured with the containerId instance of your containerType, as well as the authorization and authentication token logic you provide through a callback. It will embed itself as an iFrame into your host application. By default, the iFrame is given a `frame-ancestors` property that prevents it from being embedded by any host until configured. Details are provided below. |
| 39 | + |
| 40 | +#### SPE TypeScript React Application |
| 41 | + |
| 42 | +Follow the [quick start guide](../tutorials/spe-da-vscode.md) to get started with a prebuilt sample application. |
| 43 | + |
| 44 | +### API Documentation |
| 45 | + |
| 46 | +The SharePoint Embedded React TypeScript NPM Package, available at [here](https://github.com/microsoft/SharePoint-Embedded-Samples/tree/feature/copilot-react-sdk/sharepointembedded-chatembedded-react/docs/index.md), provides the SDK for integrating SharePoint Embedded agent into your client applications. |
| 47 | + |
| 48 | +## Frequently Asked Questions |
| 49 | + |
| 50 | +### Is consumption-based billing available for SPE agent? |
| 51 | + |
| 52 | +Yes, starting May 15th you will need to use standard Container Type to use SPE agent within an SPE application. SharePoint Embedded agent interactions, including those from Microsoft 365 Copilot license users, will be billed to the Azure subscription associated with your Container Type. Learn more about [SharePoint Embedded billing management](/sharepoint/dev/embedded/administration/billing/billingmanagement) |
| 53 | + |
| 54 | +***Trial Container Types expire after 30 days, for this reason we recommend starting off with Standard Container types. There is no upgrade path from Trial to Standard container types.*** |
| 55 | + |
| 56 | +### Should I use a standard or trial Container Type? |
| 57 | + |
| 58 | +Once consumption-based billing is enabled, we will be disabling the use of this feature with Trial Container Types and it will only be enabled on Standard Container Types going forward. Please follow this [guide](../../getting-started/containertypes.md) to get started on creating your Standard Container Type. |
| 59 | + |
| 60 | +## SharePoint Embedded agent Support |
| 61 | + |
| 62 | +### Chat Control Feedback Dialog |
| 63 | + |
| 64 | +If you encounter any issues with the chat control, please use the thumbs up or down feedback buttons to report the problem. This method is preferred for sending feedback because it provides us with telemetry data that helps us diagnose and troubleshoot the issue more effectively. |
| 65 | + |
| 66 | +When you click the thumbs down button, a feedback dialog will appear. Please include any relevant information in this dialog. |
| 67 | + |
| 68 | + |
| 69 | + |
| 70 | +## Advanced Topics Overview |
| 71 | + |
| 72 | +The [advanced topics](spe-da-adv.md) delve into how SharePoint Embedded agent use a semantic index to facilitate Retrieval-Augmented Generation (RAG), ensuring responses are accurately grounded in your stored content. You’ll also learn how to scope your agent to specific data sources, set up various file formats, and configure locale options to tailor the agent experience. By exploring concepts like grounding, semantic indexing, and RAG workflows, you can optimize your agent’s effectiveness and maintain security within the Microsoft 365 boundary. |
0 commit comments