You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can use Microsoft Graph connectors to bring data from external services into Microsoft Graph. The Microsoft Graph connectors API enables you to index external data in order to power intelligent experiences in Microsoft 365, such as [Copilot](/microsoft-365-copilot/microsoft-365-copilot-overview) and [Microsoft Search](/microsoftsearch/overview-microsoft-search).
15
+
You can use Microsoft 365 Copilot connectors (formerly Microsoft Graph connectors) to bring data from external services into Microsoft Graph. The Copilot connectors API enables you to index external data in order to power intelligent experiences in Microsoft 365, such as [Copilot](/microsoft-365-copilot/microsoft-365-copilot-overview) and [Microsoft Search](/microsoftsearch/overview-microsoft-search).
16
16
17
17
Requests to index data are performed on behalf of an application without the presence of a signed-in user via an [access token with application permission](/graph/auth-v2-service).
18
18
19
-
## Build a custom Microsoft Graph connector
19
+
## Build a custom Copilot connector
20
20
21
-
Building a custom Microsoft Graph connector involves four steps:
21
+
Building a custom Copilot connector involves four steps:
22
22
23
23
1. Create an Entra ID (formerly known as Azure Active Directory) app registration. Along with the request to Microsoft Graph, you submit the name of the app registration and API permissions that your app needs. Microsoft Graph responds with information about the newly created app registration.
24
24
2. Create an external connection. Each connection requires a unique ID, name, and a description.
25
25
3. Create the schema for the external connection. The schema defines the shape of external content that you'll ingest through this Microsoft Graph connection. Creating the schema is a long-running operation. After you submit the schema to create the connection, Microsoft Graph responds with a URL that you can use to check the status of the operation. The schema is being provisioned as long as the operation status is `inprogress`. When provisioning completes, the operation will return a `completed` status.
26
26
4. Ingest external content. For each external item, extract it from the source content repository, transform it so that it matches the schema for your external connection, and submit it to Microsoft Graph as an external item. Along with the item, include information about who's allowed to access it, also known as the access control list (ACL).
27
27
28
-
The following is a sequence diagram that illustrates the four steps to build a Microsoft Graph connector.
28
+
The following is a sequence diagram that illustrates the four steps to build a Copilot connector.
29
29
30
-
30
+
31
31
32
32
## Common use cases
33
33
34
-
The following table lists common use cases for the Microsoft Graph connectors API.
34
+
The following table lists common use cases for the Copilot connectors API.
@@ -51,9 +51,9 @@ The following are current known limitations:
51
51
- Connections have a capacity limit of 5,000,000 items or ~350 GB of data.
52
52
- Maximum size of an **externalItem** entity is 4 MB.
53
53
54
-
## Next steps
54
+
## Related content
55
55
56
-
- See the [Microsoft Graph connectors overview](/graph/connecting-external-content-connectors-overview).
56
+
- See the [Copilot connectors overview](/graph/connecting-external-content-connectors-overview).
57
57
- Drill down on the methods, properties, and relationships of the [externalConnection](externalconnectors-externalconnection.md), [schema](externalconnectors-schema.md), and [externalItem](externalconnectors-externalitem.md) resources.
58
58
- Check out the [Microsoft Graph postman collection](https://www.postman.com/microsoftgraph/workspace/microsoft-graph/folder/455214-66cbb476-ad94-448e-ba5a-ef58e1da7a90?ctx=documentation).
59
59
- Check out the [sample search connector](https://github.com/microsoftgraph/msgraph-search-connector-sample).
Copy file name to clipboardExpand all lines: api-reference/beta/resources/externalconnectors-connectionquota.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ ms.date: 07/22/2024
12
12
13
13
Namespace: microsoft.graph.externalConnectors
14
14
15
-
Represents the [connection](externalconnectors-externalconnection.md) quota that contains calculated information about the quota utilization of an external connection. It returns the allowed number of items that you can ingest into a connection by considering items ingested for the connection against the tenant-level quota for Microsoft Graph connectors.
15
+
Represents the [connection](externalconnectors-externalconnection.md) quota that contains calculated information about the quota utilization of an external connection. It returns the allowed number of items that you can ingest into a connection by considering items ingested for the connection against the tenant-level quota for Microsoft 365 Copilot connectors (formerly Microsoft Graph connectors).
Copy file name to clipboardExpand all lines: api-reference/beta/resources/search-api-overview.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ The following table describes the types available to query and the supported per
56
56
|[driveItem](driveitem.md)|Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All| SharePoint and OneDrive | Files, folders, pages, and news. |
57
57
|[list](list.md)|Sites.Read.All, Sites.ReadWrite.All| SharePoint and OneDrive | Lists. Document libraries are also returned as lists. |
58
58
|[listItem](listitem.md)|Sites.Read.All, Sites.ReadWrite.All| SharePoint and OneDrive | List items. Files and folders are also returned as list items; **listItem** is the super class of **driveItem**. |
59
-
|[externalItem](externalconnectors-externalitem.md)|ExternalItem.Read.All| Microsoft Graph connectors| All content ingested with the Microsoft Graph connectors API.|
59
+
|[externalItem](externalconnectors-externalitem.md)|ExternalItem.Read.All| Microsoft 365 Copilot connectors| All content ingested with the Copilot connectors API.|
60
60
|[person](person.md)|People.Read|Exchange Online|Personal contacts and contacts or addressable objects in your organization.|
61
61
|[qna](search-qna.md)|QnA.Read.All|Microsoft Search|Questions and answers in Microsoft Search in your organization.|
62
62
|[site](site.md)|Sites.Read.All, Sites.ReadWrite.All| SharePoint | Sites in SharePoint.|
@@ -106,7 +106,7 @@ If you don't specify any **fields** in the request, you'll get the default set
106
106
107
107
-**listItem** won't return any custom field.
108
108
-**driveItem** will return an internal listItem with an empty field.
109
-
-**externalItem** will return all the fields marked with the **retrievable** attribute in the Microsoft Graph connector schema for that particular connection.
109
+
-**externalItem** will return all the fields marked with the **retrievable** attribute in the Copilot connector schema for that particular connection.
110
110
111
111
## Keyword Query Language (KQL) support
112
112
@@ -156,7 +156,7 @@ The properties on which the aggregation is requested need to be refinable in the
156
156
157
157
Once the response is returned containing the collection of [searchBucket](searchBucket.md) objects, it's possible to refine the search request to only the matching elements contained in one [searchBucket](searchBucket.md). This is achieved by passing back the **aggregationsFilterToken** value in the **aggregationFilters** property of the subsequent [searchRequest](./searchrequest.md).
158
158
159
-
Aggregations are currently supported for any refinable property on the following SharePoint and OneDrive types: [driveItem](driveitem.md), [listItem](listitem.md), [list](list.md), [site](site.md), and on Microsoft Graph connectors [externalItem](externalconnectors-externalitem.md).
159
+
Aggregations are currently supported for any refinable property on the following SharePoint and OneDrive types: [driveItem](driveitem.md), [listItem](listitem.md), [list](list.md), [site](site.md), and on Copilot connectors [externalItem](externalconnectors-externalitem.md).
160
160
161
161
See [refine search results](/graph/search-concept-aggregation) for examples that show using aggregation to enhance and narrow down search results.
Copy file name to clipboardExpand all lines: api-reference/beta/resources/searchrequest.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: "searchRequest resource type"
3
-
description: "The search request to be sent to the query endpoint. It contains the type of entities expected in the response, the underlying sources, the paging parameters, the fields request and the actual search query."
3
+
description: "The search request to be sent to the query endpoint. It contains the type of entities expected in the response, the underlying sources, the paging parameters, the fields request, and the actual search query."
4
4
ms.localizationpriority: medium
5
5
author: "njerigrevious"
6
6
ms.subservice: "search"
@@ -18,7 +18,7 @@ Namespace: microsoft.graph
18
18
19
19
A search request formatted in a JSON blob.
20
20
21
-
The JSON blob contains the types of resources expected in the response, the underlying sources, paging parameters, sort options, requested aggregations and fields, and actual search query. See [examples](#related-content) of search requests on various resources.
21
+
The JSON blob contains the types of resources expected in the response, the underlying sources, paging parameters, sort options, requested aggregations and fields, and the actual search query. See [examples](#related-content) of search requests on various resources.
22
22
23
23
> [!NOTE]
24
24
> Be aware of [known limitations](search-api-overview.md#known-limitations) on searching specific combinations of entity types, and sorting or aggregating search results.
@@ -30,19 +30,19 @@ The JSON blob contains the types of resources expected in the response, the unde
30
30
|aggregations|[aggregationOption](aggregationOption.md) collection|Specifies aggregations (also known as refiners) to be returned alongside search results. Optional.|
31
31
|aggregationFilters|String collection|Contains one or more filters to obtain search results aggregated and filtered to a specific value of a field. Optional.<br>Build this filter based on a prior search that aggregates by the same field. From the response of the prior search, identify the [searchBucket](searchBucket.md) that filters results to the specific value of the field, use the string in its **aggregationFilterToken** property, and build an aggregation filter string in the format **"{field}:\\"{aggregationFilterToken}\\""**. <br>If multiple values for the same field need to be provided, use the strings in its **aggregationFilterToken** property and build an aggregation filter string in the format **"{field}:or(\\"{aggregationFilterToken1}\\",\\"{aggregationFilterToken2}\\")"**. <br>For example, searching and aggregating drive items by file type returns a **searchBucket** for the file type `docx` in the response. You can conveniently use the **aggregationFilterToken** returned for this **searchBucket** in a subsequent search query and filter matches down to drive items of the `docx` file type. [Example 1](/graph/search-concept-aggregation#example-1-request-aggregations-by-string-fields) and [example 2](/graph/search-concept-aggregation#example-2-apply-an-aggregation-filter-based-on-a-previous-request) show the actual requests and responses.|
32
32
|collapseProperties|[collapseProperty](collapseproperty.md) collection|Contains the ordered collection of fields and limit to collapse results. Optional.|
33
-
|contentSources|String collection|Contains the connection to be targeted. <br>Respects the following format: `/external/connections/connectionid` where `connectionid` is the ConnectionId defined in the Connectors Administration. <br> Note: contentSource is only applicable when entityType=`externalItem`. Optional.|
33
+
|contentSources|String collection|Contains the connection to be targeted. <br>Respects the following format: `/external/connections/connectionid` where `connectionid` is the ConnectionId defined in the connectors administration. <br> Note: contentSource is only applicable when entityType=`externalItem`. Optional.|
34
34
|enableTopResults|Boolean|This triggers hybrid sort for messages: the first 3 messages are the most relevant. This property is only applicable to entityType=`message`. Optional.|
35
35
|entityTypes|entityType collection| One or more types of resources expected in the response. Possible values are: `list`, `site`, `listItem`, `message`, `event`, `drive`, `driveItem`, `person`, `externalItem`, `acronym`, `bookmark`, `chatMessage`. For details about combinations of two or more entity types that are supported in the same search request, see [known limitations](search-api-overview.md#known-limitations). Required.|
36
-
|fields|String collection |Contains the fields to be returned for each resource object specified in **entityTypes**, allowing customization of the fields returned by default otherwise, including additional fields such as custom managed properties from SharePoint and OneDrive, or custom fields in **externalItem** from content that Microsoft Graph connectors bring in. <br>The fields property can be using the [semantic labels](/microsoftsearch/configure-connector#step-5-assign-property-labels) applied to properties. For example, if a property is label as title, you can retrieve it using the following syntax : label_title.<br>Optional.|
36
+
|fields|String collection |Contains the fields to be returned for each resource object specified in **entityTypes**, allowing customization of the fields returned by default otherwise, including additional fields such as custom managed properties from SharePoint and OneDrive, or custom fields in **externalItem** from content that Microsoft 365 Copilot connectors bring in. <br>The fields property can be using the [semantic labels](/microsoftsearch/configure-connector#step-5-assign-property-labels) applied to properties. For example, if a property is labeled as title, you can retrieve it using the following syntax : label_title.<br>Optional.|
37
37
|from|Int32|Specifies the offset for the search results. Offset 0 returns the very first result. Optional.|
38
38
|query|[searchQuery](searchquery.md)|Contains the query terms. Required.|
39
39
|queryAlterationOptions|[searchAlterationOptions](searchalterationoptions.md)|Provides query alteration options formatted as a JSON blob that contains two optional flags related to spelling correction. Optional. |
40
40
|region|string|Required for searches that use application permissions. Represents the geographic location for the search. For details, see [Get the region value](/graph/search-concept-searchAll). |
41
41
|resultTemplateOptions|[resultTemplateOption](resultTemplateOption.md) collection|Provides the search result templates options for rendering connectors search results.|
42
-
|sharePointOneDriveOptions|[sharePointOneDriveOptions](sharePointOneDriveOptions.md)|Indicates the kind of contents to be searched when a search is performed using application permissions. Optional.|
42
+
|sharePointOneDriveOptions|[sharePointOneDriveOptions](sharePointOneDriveOptions.md)|Indicates the kind of content to be searched when a search is performed using application permissions. Optional.|
43
43
|size|Int32|The size of the page to be retrieved. The maximum value is 500. Optional.|
44
44
|sortProperties|[sortProperty](sortProperty.md) collection|Contains the ordered collection of fields and direction to sort results. There can be at most 5 sort properties in the collection. Optional.|
45
-
|trimDuplicates|Boolean|Indicates whether to trim away the duplicate SharePoint files from search results. Default value is `false`. Optional.|
45
+
|trimDuplicates|Boolean|Indicates whether to trim away the duplicate SharePoint files from search results. The default value is `false`. Optional.|
46
46
|stored_fields (deprecated)|String collection |This is now replaced by the **fields** property. |
Copy file name to clipboardExpand all lines: api-reference/includes/search-api-preview-signup.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -8,4 +8,4 @@ ms.localizationpriority: medium
8
8
<!-- markdownlint-disable MD041-->
9
9
10
10
> [!IMPORTANT]
11
-
> Microsoft Graph connectors and are currently in public preview status. To gain access to connectors functionality, you must turn on the Targeted release option in your tenant. See more details on the [connectors preview program](/microsoftsearch/connectors-preview).
11
+
> Microsoft 365 Copilot connectors are currently in public preview status. To gain access to connectors functionality, you must turn on the Targeted release option in your tenant. For more information, see the [connectors preview program](/microsoftsearch/connectors-preview).
0 commit comments