This page was recently updated. What do you think about it? Let us know!.

Connect OneDrive 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 OneDrive account.

  • The User Principal Name (UPN) for the OneDrive account. This is typically the OneDrive account user’s email address.

  • The path to the target OneDrive folder, starting from the OneDrive account’s root folder, for example my-folder/my-subfolder.

  • The client ID, tenant ID, and client secret for the Microsoft Entra ID app registration that has access to the target OneDrive account and also has the correct set of Microsoft Graph authentication scopes. These scopes include:

    • Files.ReadWrite.All (if both reading and writing are needed)
    • Sites.ReadWrite.All (if both reading and writing are needed)
    • User.Read.All
    • Directory.Read.All

See also:

The OneDrive connector dependencies:

CLI, Python
pip install "unstructured-ingest[onedrive]"

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

The following environment variables:

  • ONEDRIVE_PATH - The path to the target folder in the OneDrive account, starting with the account’s root folder (for example my-folder/my-subfolder), represented by --path (CLI) or path (Python).
  • ONEDRIVE_CLIENT_ID - The application (client) ID of the Microsoft Entra ID app registration that has access to the OneDrive account, represented by --client-id (CLI) or client_id (Python).
  • ONEDRIVE_CLIENT_CRED - The client secret for the Entra ID app registration, represented by --client-cred (CLI) or client_cred (Python).
  • ONEDRIVE_TENANT - The directory (tenant) ID of the Entra ID app registration, represented by --tenant (CLI) or tenant (Python).
  • ONEDRIVE_USER_PNAME - The User Principal Name (UPN) for the OneDrive user account in Entra ID (typically the user’s email address), represented by --user-pname (CLI) or user_pname (Python).
  • ONEDRIVE_AUTHORITY_URL - The authentication token provider URL for the Entra ID app registration (the default is https://login.microsoftonline.com if not otherwise specified), represented by --authority-url (CLI) or authority_url (Python).

These environment variables:

  • UNSTRUCTURED_API_KEY - Your Unstructured API key value.
  • UNSTRUCTURED_API_URL - Your Unstructured API URL.

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:

Was this page helpful?

NotionOpenSearch