OneDrive

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:

• Registering your app for Microsoft Graph
• OneDrive authentication and sign-in
• OneDrive API documentation

The OneDrive connector dependencies:

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).

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 API services for processing by default. To process data locally instead, see the instructions at the end of this page.

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 Unstructured API services for processing, specify --partition-by-api (CLI) or partition_by_api=True (Python).

  Unstructured API services 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.

  Get an API key and API URL.