Skip to content
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.

Sign up for GitHub

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

SPE Declarative Agents Lite documentation #10123

Merged
merged 9 commits into from
Mar 6, 2025
Merged

SPE Declarative Agents Lite documentation #10123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f19463a
SPE copilot documentation
Mar 5, 2025
17bb9a9
Fix links
Mar 5, 2025
9c017e9
Remove mention of chatembedded.aspx
Mar 5, 2025
919dfec
Fix toc link
Mar 5, 2025
5cd0179
Updated locale information
Mar 5, 2025
945a402
Update doc link
Mar 5, 2025
922d47c
typos & copy edits
andrewconnell Mar 6, 2025
8831bb4
grammar & markdown formatting fixes
andrewconnell Mar 6, 2025
1885bc9
typos, grammatical fixes, and markdown fixes
andrewconnell Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 189 additions & 0 deletions docs/embedded/development/declarative-agent/spe-da-adv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
---
title: SharePoint Embedded copilots Advanced Topics
description: Learn how the semantic index powers Retrieval-Augmented Generation (RAG) to provide accurate, context-aware AI responses in SharePoint Embedded copilots.
ms.date: 3/03/2025
ms.localizationpriority: high
---

# SharePoint Embedded copilot Advanced Topics Overview

This advanced guide covers how the semantic index powers Retrieval-Augmented Generation (RAG) to provide accurate, context-aware AI responses. We’ll explore how these concepts work together to ensure your copilot retrieves relevant information from your data and returns grounded answers.

## Advanced Topics

### Semantic index

[Learn more about semantic index for Microsoft 365 Copilot here](/microsoftsearch/semantic-index-for-copilot)

The semantic index allows for quick and accurate searches based on data similarity. This means it can find the most relevant information not just by exact matches, but also by understanding the context and meaning.

### RAG ( Retrieval-Augmented Generation )

RAG relies on having relevant source materials stored in a repository, which can be queried at runtime​, data is retrieved from the index and is used to augment the prompt sent to the large language model (LLM)​:

- Treat data sources as knowledge without having to train your model​
- Uses search (retrieval) results as additional context in your prompt​
- Generates the output using the prompt and the supplied context

The LLM uses the data to inform and construct the response.

​![The flow of a RAG query](../../images/speco-ragquery.png)

### Grounding

Grounding in the context of SPE copilot refers to the process of providing input sources to the large language model (LLM) related to the user's prompt. This helps improve the specificity of the prompt and ensures that the responses are relevant and actionable to the user's specific task. The data the copilot is grounded on will be on the contents of the container type in the copilot application. Behind the scenes SPE copilot uses M365 Copilot, [learn more about it's architecture here](/copilot/microsoft-365/microsoft-365-copilot-architecture)

### Scoping your copilot to specific content

SharePoint Embedded (SPE) copilot has the ability to restrict the data sources it has access to, below are provided types, and this [example](https://github.com/microsoft/SharePoint-Embedded-Samples/blob/main/Samples/spe-typescript-react-azurefunction/react-client/src/providers/ChatController.ts#L15) shows how to configure the SDK

```typescript
export type IDataSourcesProps =
| IFileDataSource
| IFolderDataSource
| IDocumentLibraryDataSource
| ISiteDataSource
| IWorkingSetDataSource
| IMeetingDataSource;

export enum DataSourceType {
File = 'File',
Folder = 'Folder',
DocumentLibrary = 'DocumentLibrary',
Site = 'Site',
WorkingSet = 'WorkingSet',
Meeting = 'Meeting'
}
```

#### Supported document types for scoping

[Reference - File Formats Support By copilot](https://support.microsoft.com/topic/file-formats-supported-by-copilot-1afb9a70-2232-4753-85c2-602c422af3a8)

**Documents**: PDF, DOCX, XLSX, PPTX

**Text-based Files**: RTF, TXT, CSV, LOG, INI, CONFIG

**Audio**: WAV

**Programming Languages**: PY, JS, JSX, JAVA, PHP, CS, C, CPP, CXX, H, HPP, M, COFFEE, DART, LUA, PL, PM, RB, RS, SWIFT, GO, KT, KTS, R, SCALA, T, TS, TSX

**Shell Scripts**: BASH, SH, ZSH

**Markup and Documentation**: HTML, CSS, MD, RMD, TEX, LATEX

**Database Languages**: SQL

**Data Serialization Formats**: IPYNB, JSON, TOML, YAML, YML

##### Language/Locale

The copilot iframe dynamically loads localization settings to ensure that the chat interface is displayed in the appropriate language. These settings are derived from SharePoint, which provides a comprehensive set of localization options.

When the copilot iframe is initialized, it retrieves the current localization settings from SharePoint. These settings dictate the language and regional preferences for the chat interface, ensuring that all UI elements, messages, and interactions are presented in the user's preferred language. This seamless integration with SharePoint's localization framework allows copilot to provide a consistent an

You can have this localized by setting your language options in the SharePoint account settings: [Change your personal language and region settings - Microsoft Support](https://support.microsoft.com/en-us/office/change-your-personal-language-and-region-settings-caa1fccc-bcdb-42f3-9e5b-45957647ffd7) note, if your M365 setting is different from your Sharepoint account langauge settings it will take precedence, you can change your M365 language settings here: [Change your display language in Microsoft 365](https://support.microsoft.com/en-us/topic/change-your-display-language-and-time-zone-in-microsoft-365-for-business-6f238bff-5252-441e-b32b-655d5d85d15b)

An additional locale option can be passed in through the `ChatLaunchConfig` to further set the language the copilot will respond in:

```typescript
const [chatConfig] = React.useState<ChatLaunchConfig>({
header: ChatController.instance.header,
theme: ChatController.instance.theme,
zeroQueryPrompts: ChatController.instance.zeroQueryPrompts,
suggestedPrompts: ChatController.instance.suggestedPrompts,
instruction: ChatController.instance.pirateMetaPrompt,
locale: "en",
});
```

###### Locale Options

Here are some examples of locale options you can use:

| Locale Code | Common Name |
|--------------|------------------------------------------|
| af | Afrikaans |
| en-gb | English (UK) |
| he | Hebrew |
| kok | Konkani |
| nn-no | Norwegian (Nynorsk) |
| sr-latn-rs | Serbian (Latin, Serbia) |
| am-et | Amharic |
| es | Spanish |
| hi | Hindi |
| lb-lu | Luxembourgish |
| or-in | Odia (India) |
| sv | Swedish |
| ar | Arabic |
| es-mx | Spanish (Mexico) |
| hr | Croatian |
| lo | Lao |
| pa | Punjabi |
| ta | Tamil |
| as-in | Assamese |
| et | Estonian |
| hu | Hungarian |
| lt | Lithuanian |
| pl | Polish |
| te | Telugu |
| az-latn-az | Azerbaijani (Latin, Azerbaijan) |
| eu | Basque |
| hy | Armenian |
| lv | Latvian |
| pt-br | Portuguese (Brazil) |
| th | Thai |
| bg | Bulgarian |
| fa | Persian |
| id | Indonesian |
| mi-nz | Maori (New Zealand) |
| pt-pt | Portuguese (Portugal) |
| tr | Turkish |
| bs-latn-ba | Bosnian (Latin, Bosnia and Herzegovina) |
| fi | Finnish |
| is | Icelandic |
| mk | Macedonian |
| quz-pe | Quechua (Peru) |
| tt | Tatar |
| ca-es-valencia | Catalan (Valencian) |
| fil-ph | Filipino (Philippines) |
| it | Italian |
| ml | Malayalam |
| ro | Romanian |
| ug | Uyghur |
| ca | Catalan |
| fr-ca | French (Canada) |
| ja | Japanese |
| mr | Marathi |
| ru | Russian |
| uk | Ukrainian |
| cs | Czech |
| fr | French |
| ka | Georgian |
| ms | Malay |
| sk | Slovak |
| ur | Urdu |
| cy-gb | Welsh (UK) |
| ga-ie | Irish (Ireland) |
| kk | Kazakh |
| mt-mt | Maltese (Malta) |
| sl | Slovenian |
| uz-latn-uz | Uzbek (Latin, Uzbekistan) |
| da | Danish |
| gd | Scottish Gaelic |
| km-kh | Khmer (Cambodia) |
| nb-no | Norwegian (Bokmål) |
| sq | Albanian |
| vi | Vietnamese |
| de | German |
| gl | Galician |
| kn | Kannada |
| ne-np | Nepali (Nepal) |
| sr-cyrl-ba | Serbian (Cyrillic, Bosnia and Herzegovina)|
| zh-cn | Chinese (Simplified) |
| el | Greek |
| gu | Gujarati |
| ko | Korean |
| nl | Dutch |
| sr-cyrl-rs | Serbian (Cyrillic, Serbia) |
| zh-tw | Chinese (Traditional) |
Loading