From 3424b479bc71b10db8cf4defadd57dd46d279c41 Mon Sep 17 00:00:00 2001
From: anakin87 <44616784+anakin87@users.noreply.github.com>
Date: Thu, 24 Sep 2026 10:27:12 +0000
Subject: [PATCH] Sync Core Integrations API reference (microsoft_sharepoint)
on Docusaurus
---
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
.../integrations-api/microsoft_sharepoint.md | 25 +++++++++++--------
18 files changed, 270 insertions(+), 180 deletions(-)
diff --git a/docs-website/reference/integrations-api/microsoft_sharepoint.md b/docs-website/reference/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.18/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.18/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.18/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.18/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.19/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.19/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.19/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.19/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.20/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.20/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.20/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.20/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.21/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.21/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.21/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.21/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.22/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.22/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.22/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.22/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.23/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.23/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.23/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.23/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.24/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.24/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.24/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.24/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.25/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.25/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.25/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.25/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.26/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.26/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.26/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.26/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.27/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.27/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.27/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.27/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.28/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.28/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.28/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.28/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.29/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.29/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.29/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.29/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.30/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.30/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.30/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.30/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-2.31/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-2.31/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-2.31/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-2.31/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-3.0/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-3.0/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-3.0/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-3.0/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-3.1/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-3.1/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-3.1/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-3.1/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
diff --git a/docs-website/reference_versioned_docs/version-3.2-unstable/integrations-api/microsoft_sharepoint.md b/docs-website/reference_versioned_docs/version-3.2-unstable/integrations-api/microsoft_sharepoint.md
index c928b2655ad..cade66e5c93 100644
--- a/docs-website/reference_versioned_docs/version-3.2-unstable/integrations-api/microsoft_sharepoint.md
+++ b/docs-website/reference_versioned_docs/version-3.2-unstable/integrations-api/microsoft_sharepoint.md
@@ -185,10 +185,10 @@ list items and pages by ID (`site_id`, `list_id`, `list_item_id`, `list_item_uni
download or convert the underlying files. Compose a downstream fetcher/converter (such as
`MSSharePointFetcher`) when full content is needed.
-The retriever takes a per-user `access_token` as a run input, typically wired
-from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
-(for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
-delegated permissions only.
+The retriever takes an `access_token` as a run input. For delegated (on-behalf-of) auth, pass a
+per-user token wired from an upstream `OAuthResolver`; the token must carry delegated Microsoft Graph
+permissions (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). For app-only
+(client-credentials) auth, pass an application token and set the `region` parameter at init time.
### Usage example
@@ -219,6 +219,7 @@ __init__(
top_k: int = 10,
fields: list[str] | None = None,
query_template: str | None = None,
+ region: str | None = None,
graph_url: str = DEFAULT_GRAPH_URL,
timeout: float = 30.0,
max_retries: int = 3
@@ -242,6 +243,10 @@ Initialize the retriever.
`'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
placeholder is replaced by the run-time query. The template uses
[Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+- **region** (str | None) – The region code for the Microsoft Search index, for example `"NAM"`, `"EUR"`, or `"APC"`.
+ Required when using application permissions (app-only / client-credentials auth); omit for delegated
+ (on-behalf-of) tokens. See the `region` property of the
+ [searchRequest resource](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
- **graph_url** (str) – The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
Override for sovereign clouds.
- **timeout** (float) – The HTTP timeout in seconds for each request to Microsoft Graph.
@@ -268,9 +273,9 @@ Search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**
@@ -298,9 +303,9 @@ Asynchronously search SharePoint and OneDrive and return the matching documents.
operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
`path:"https://contoso.sharepoint.com/sites/Team"`. See the
[KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
-- **access_token** (str | Secret) – A delegated Microsoft Graph bearer token for the user whose content is searched,
- typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
- accepted and resolved internally.
+- **access_token** (str | Secret) – A Microsoft Graph bearer token. For delegated auth, pass a per-user token wired from
+ an upstream `OAuthResolver`. For app-only (client-credentials) auth, pass an application token and set
+ `region` at init time. A `Secret` is also accepted and resolved internally.
- **top_k** (int | None) – Overrides the `top_k` configured at initialization for this run.
**Returns:**