SharePoint

Connect SharePoint to your preprocessing pipeline, and use the Unstructured Ingest CLI or the Unstructured Ingest Python library to batch process all your documents and store structured outputs locally on your filesystem.

The requirements are as follows.

• A SharePoint Online plan, or a Microsoft 365 or Office 365 Business or enterprise plan that includes SharePoint Online. Learn more. Shop for business plans. Shop for enterprise plans.

• A OneDrive for business plan, or a Microsoft 365 or Office 365 Business or enterprise plan that includes OneDrive. (Even if you only plan to use SharePoint Online, you still need a plan that includes OneDrive, because the SharePoint connector is built on OneDrive technology.) Learn more. Shop for business plans. Shop for enterprise plans. OneDrive personal accounts, and Microsoft 365 Free, Basic, Personal, and Family plans are not supported.

• The SharePoint Online and OneDrive plans must share the same Microsoft Entra ID tenant. Learn more.

• The SharePoint Online site URL.

  • Site collection-level URLs typically have the format https://<tenant>.sharepoint.com/sites/<site-collection-name>.
  • Root site collection-level URLs typically have the format https://<tenant>.sharepoint.com.
  • To process all sites within a SharePoint tenant, use a site URL of https://<tenant>-admin.sharepoint.com.

  Learn more.

• The display name of the SharePoint Online library to use. The default is Documents.

• The path to the SharePoint Online library to use. By default, the root of the target library is used. To start from a path other than the root, enter the path that you want to use, beginning from the root. For example, to use the my-folder > my-subfolder path in the target library, you would specify my-folder/my-subfolder.

  The following video shows how to get the site URL and a path within the site:

• Two types of authentication are supported: client credentials and a username and password. Both authentication types require a Microsoft Entra ID app registration. You will need to provide the Application (client) ID, Directory (tenant) ID, and Client secret for the Entra ID app registration, and the app registration must have the correct set of Microsoft Graph access permissions. These permissions include:

  • Sites.ReadWrite.All (if both reading and writing are needed)

  • User.Read.All Learn more.

  1. Create an Entra ID app registration.
  2. Add Graph access permissions to an app registration.
  3. Grant consent for the added Graph permissions.

  The following video shows how to create an Entra ID app registration:

  The following video shows how to add the correct set of Graph access permissions to the Entra ID app registration:

• The token authority URL for your Microsoft Entra ID app registration. This is typically https://login.microsoftonline.com

• For username and password authentication, you must also provide the User Principal Name (UPN) and its password for the OneDrive account in the Microsoft Entra ID tenant. This UPN is typically the OneDrive account user’s email address. To find a UPN:

  1. Depending on your plan, sign in to your Microsoft 365 admin center (typically https://admin.microsoft.com) using your administrator credentials, or sign in to your Office 365 portal (typically https://portal.office.com) using your credentials.
  2. In the Users section, click Active users.
  3. Locate the user account in the list of active users.
  4. The UPN is displayed in the Username column.

  The following video shows how to get a UPN:

The SharePoint connector dependencies:

pip install "unstructured-ingest[sharepoint]"

You might also need to install additional dependencies, depending on your needs. Learn more.

The following environment variables:

• SHAREPOINT_SITE_URL - The SharePoint site URL, represented by --site (CLI) or site (Python).
• SHAREPOINT_LIBRARY_NAME - The display name of the SharePoint library to use, represented by --library (CLI) or library (Python). The default is Documents.
• SHAREPOINT_SITE_PATH - The path to use within the library, represented by --path (CLI) or path (Python). The default is the root of the target library. To use a different path, specify the correct path format as described previously in this article.
• ENTRA_ID_APP_CLIENT_ID - The Application (client) ID value for the Microsoft Entra ID app registration, represented by --client-id (CLI) or client_id (Python).
• ENTRA_ID_APP_TENANT_ID - The Directory (tenant) ID value for the Entra ID app registration, represented by --client-id (CLI) or client_id (Python).
• ENTRA_ID_TOKEN_AUTHORITY_URL - The token authority URL for the Entra ID app registration, represented by --authority-url (CLI) or authority_url (Python). The default is https://login.microsoftonline.com.
• ENTRA_ID_APP_CLIENT_SECRET - The Client secret value for the Entra ID app registration, represented by --client-cred (CLI) or client_cred (Python).
• ENTRA_ID_USER_PRINCIPAL_NAME - For username and password authentication, the User Principal Name (UPN) for the target OneDrive account in the Microsoft Entra ID tenant.
• ENTRA_ID_USER_PASSWORD - For username and password authentication, the password for the target UPN.

Now call the Unstructured Ingest CLI or the Unstructured Ingest Python library. The destination connector can be any of the ones supported. This example uses the local destination connector.

This example sends data to Unstructured for processing by default. To process data locally instead, see the instructions at the end of this page.

#!/usr/bin/env bash

unstructured-ingest \
  sharepoint \
    --site $SHAREPOINT_SITE_URL \
    --library $SHAREPOINT_LIBRARY_NAME \
    --path $SHAREPOINT_SITE_PATH \
    --recursive \
    --client-id $ENTRA_ID_APP_CLIENT_ID \
    --tenant $ENTRA_ID_APP_TENANT_ID \
    --authority-url $ENTRA_ID_TOKEN_AUTHORITY_URL \
    --client-cred $ENTRA_ID_APP_CLIENT_SECRET \
    --user-pname $ENTRA_ID_USER_PRINCIPAL_NAME \
    --password $ENTRA_ID_USER_PASSWORD \
    --download-dir $LOCAL_FILE_DOWNLOAD_DIR \
    --partition-by-api \
    --api-key $UNSTRUCTURED_API_KEY \
    --partition-endpoint $UNSTRUCTURED_API_URL \
    --strategy hi_res \
    --output-dir $LOCAL_FILE_OUTPUT_DIR \
    --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}"

For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you can use the --partition-by-api option (CLI) or partition_by_api (Python) parameter to specify where files are processed:

• To do local file processing, omit --partition-by-api (CLI) or partition_by_api (Python), or explicitly specify partition_by_api=False (Python).

  Local file processing does not use an Unstructured API key or API URL, so you can also omit the following, if they appear:

  • --api-key $UNSTRUCTURED_API_KEY (CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY") (Python)
  • --partition-endpoint $UNSTRUCTURED_API_URL (CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL") (Python)
  • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_API_URL

• To send files to the Unstructured Partition Endpoint for processing, specify --partition-by-api (CLI) or partition_by_api=True (Python).

  Unstructured also requires an Unstructured API key and API URL, by adding the following:

  • --api-key $UNSTRUCTURED_API_KEY (CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY") (Python)
  • --partition-endpoint $UNSTRUCTURED_API_URL (CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL") (Python)
  • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_API_URL, representing your API key and API URL, respectively.
  You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, for example, if you are using a self-hosted instance of the Unstructured API.

  The default API URL for Unstructured Ingest is https://api.unstructuredapp.io/general/v0/general, which is the API URL for the Unstructured Partition Endpoint. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at sales@unstructured.io.

  If you do not have an API key, get one now.

  If the Unstructured API is self-hosted, the process for generating Unstructured API keys, and the Unstructured API URL that you use, are different. For details, contact Unstructured Sales at sales@unstructured.io.