Skip to content

Update SPE agent spe-da.md #10249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 19, 2025
Merged

Update SPE agent spe-da.md #10249

merged 2 commits into from
May 19, 2025

Conversation

clalissayi24
Copy link
Contributor

Updating SPE copilot --> SPE agent

Category

  • Content fix
  • New article

Related issues

  • fixes #issuenumber
  • partially #issuenumber
  • mentioned in #issuenumber

What's in this Pull Request?

Cleaned up verbiage here for entire doc:

  • SPE copilot -> SPE agent
  • Updated FAQ to reflect current status of PAYG
  • Note section: cleaned up run on sentence

Submission guidelines

  • !!IMPORTANT!! - All submissions must complete the baseline sections included in this template. Ignoring or deleting this template may result in closing the issue with the label type:incomplete-submission.
  • Follow our guidance on How To Create Good Pull Requests.
  • Target the main branch of this repo.
  • When changing a page, ensure you update the ms.date front matter wih the current date in the format MM/DD/YYYY.
  • Review all build checks and address the automated errors, warnings, and suggestions.
  • NOTE: The live site is based on the live branch. Site owners periodically refresh live branch from the main branch so merged PRs won't immediately appear on the live site. Please be patient to see your changes appear on the live site.

Cleaned up verbiage here for entire doc:
* SPE copilot -> SPE agent
* Updated FAQ to reflect current status of PAYG
* Note section: cleaned up run on sentence
Copy link
Contributor

Learn Build status updates of commit 071c1e1:

✅ Validation status: passed

File Status Preview URL Details
docs/embedded/development/declarative-agent/spe-da.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@cindylay
Copy link
Contributor

@yratna can you review this content to make sure it is correct?

@cindylay
Copy link
Contributor

@dluces as an FYI

@cindylay
Copy link
Contributor

will approve once SMEs sign off

>
> SPE copilot 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 copilot within an SPE application, you will need to use standard Container Type and copilot interactions, including those from 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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Copilot interactions" should be changed to "SPE agent interactions"

@@ -1,21 +1,21 @@
---
title: SharePoint Embedded copilot
title: SharePoint Embedded agent
description: Details copilot integration with SharePoint Embedded applications
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Debatable use of "copilot" here--we should probably avoid all mentions to copilot. "Details usage and billing for SharePoint Embedded agents" maybe?


SharePoint Embedded copilot enables you to build Microsoft 365 Copilot functionality into your application through a simple SDK. This copilot chat control offers the following features:
SharePoint Embedded agent enables you to build Microsoft 365 Copilot functionality into your application through a simple SDK. This copilot chat control offers the following features:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SharePoint Embedded agent enables you to build Microsoft 365 Copilot functionality add AI capabilities into your application through a simple SDK. This copilot chat control offers the following features:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Copilot interactions, including those from Copilot license users" - should it starts with "Microsoft 365 Copilot"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are not M365 copilot interactions. These are SPE agent interactions. We should actually not talk about anything M365 Copilot related here to avoid confusion. The only accepted reference to copilot would be to clarify that Copilot licences do not count towards SPE agents and that usage will be billed consumptively for those users too.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant to say should "Copilot license users" be "Microsoft 365 Copilot license users"?


Currently you need a Microsoft 365 Copilot license enabled for your user to use SharePoint Embedded copilot. When consumption-based billing is enabled, you will no longer require a license, however, you will be required to use a Standard Container type.
Yes, starting May 15th you will need to use standard Container Type to use SPE agent within an SPE application. Copilot interactions, including those from 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"SharePoint Embedded agent interactions" instead of "Copilot interactions"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Copilot interactions, including those from Copilot license users" - should it starts with "Microsoft 365 Copilot"?


## Advanced Topics Overview

The [advanced topics](spe-da-adv.md) delve into how SharePoint Embedded copilot 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 copilot to specific data sources, set up various file formats, and configure locale options to tailor the copilot experience. By exploring concepts like grounding, semantic indexing, and RAG workflows, you can optimize your copilot’s effectiveness and maintain security within the Microsoft 365 boundary.
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 copilot to specific data sources, set up various file formats, and configure locale options to tailor the copilot experience. By exploring concepts like grounding, semantic indexing, and RAG workflows, you can optimize your copilot’s effectiveness and maintain security within the Microsoft 365 boundary.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change "copilot" for "agent". "...your agent to specific data sources", "...tailor the agent experience", "...optimize you agent's effectiveness"


SharePoint Embedded copilot enables you to build Microsoft 365 Copilot functionality into your application through a simple SDK. This copilot chat control offers the following features:
SharePoint Embedded agent enables you to build Microsoft 365 Copilot functionality into your application through a simple SDK. This copilot chat control offers the following features:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Copilot interactions, including those from Copilot license users" - should it starts with "Microsoft 365 Copilot"?


Currently you need a Microsoft 365 Copilot license enabled for your user to use SharePoint Embedded copilot. When consumption-based billing is enabled, you will no longer require a license, however, you will be required to use a Standard Container type.
Yes, starting May 15th you will need to use standard Container Type to use SPE agent within an SPE application. Copilot interactions, including those from 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Copilot interactions, including those from Copilot license users" - should it starts with "Microsoft 365 Copilot"?


Currently you need a Microsoft 365 Copilot license enabled for your user to use SharePoint Embedded copilot. When consumption-based billing is enabled, you will no longer require a license, however, you will be required to use a Standard Container type.
Yes, starting May 15th you will need to use standard Container Type to use SPE agent within an SPE application. Copilot interactions, including those from 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)

***Trial Container Types expire after 30 days, for this reason we recommend starting off with Standard Container types. Currently there is no upgrade path from Trial to Standard container types.***

### Should I use a standard or trial container type?

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On "trial container types" and "standard container types", capitalization matters. It needs to always be "Container Type". Trial and standard, have no preference/mandate


Currently you need a Microsoft 365 Copilot license enabled for your user to use SharePoint Embedded copilot. When consumption-based billing is enabled, you will no longer require a license, however, you will be required to use a Standard Container type.
Yes, starting May 15th you will need to use standard Container Type to use SPE agent within an SPE application. Copilot interactions, including those from 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)

***Trial Container Types expire after 30 days, for this reason we recommend starting off with Standard Container types. Currently there is no upgrade path from Trial to Standard container types.***
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Currently there is no upgrade path from Trial to Standard container types" - can we reword this to not potentially create a false expectation that someday we will provide a path for trial->standard?


***Trial Container Types expire after 30 days, for this reason we recommend starting off with Standard Container types. Currently there is no upgrade path from Trial to Standard container types.***

### Should I use a standard or trial container type?

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.

## SharePoint Embedded copilot Support
## SharePoint Embedded agent Support

### Chat Control Feedback Dialog

If you encounter any issues with the chat control, please use the thumbs up and 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"thumbs up and down" ---> "thumbs up or down"

@andrewconnell andrewconnell self-assigned this May 15, 2025
@andrewconnell andrewconnell added the pr:in-review Actively reviewing pull request label May 15, 2025
@andrewconnell
Copy link
Collaborator

@clalissayi24 action required on your part... we can't merge content for people who haven't completed the CLA. See the steps above for instructions on what to do.

FYI @cindylay

@andrewconnell andrewconnell added pr:do-not-merge Pull request not ready to be merged Needs: Author complete CLA Author has not signed the CLA. Contributions cannot be accepted into the docs unless & until the aut and removed pr:in-review Actively reviewing pull request labels May 15, 2025
Updated based on comments from Diego and Tony
Copy link
Contributor

Learn Build status updates of commit 5ca72ae:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/embedded/development/auth.md ⚠️Warning View Details
docs/toc.yml ⚠️Warning View Details
docs/embedded/development/declarative-agent/spe-da.md 💡Suggestion n/a (file deleted or renamed) Details
docs/embedded/development/declarative-agent/spe-da2.md ✅Succeeded View

docs/embedded/development/auth.md

  • Line 66, Column 3: [Warning: file-not-found - See documentation] Invalid file link: './declarative-agent/spe-da.md'.
  • Line 79, Column 12: [Warning: file-not-found - See documentation] Invalid file link: './declarative-agent/spe-da.md'.

docs/toc.yml

  • Line 628, Column 13: [Warning: file-not-found - See documentation] Invalid file link: 'embedded/development/declarative-agent/spe-da.md'.

docs/embedded/development/declarative-agent/spe-da.md

  • [Suggestion: file-not-redirected - See documentation] File docs/embedded/development/declarative-agent/spe-da.md with URL /sharepoint/dev/embedded/development/declarative-agent/spe-da was deleted without redirection. To avoid broken links, add a redirection.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@clalissayi24
Copy link
Contributor Author

@microsoft-github-policy-service agree company="Microsoft"

@VesaJuvonen VesaJuvonen merged commit a39605f into SharePoint:main May 19, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs: Author complete CLA Author has not signed the CLA. Contributions cannot be accepted into the docs unless & until the aut pr:do-not-merge Pull request not ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants