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.

You will need:

The SharePoint prerequisites, which include the following settings.

• The SharePoint site URL.

  • Site URLs typically have the format https://<tenant>.sharepoint.com.
  • Relative site URLs typically have the format https://<tenant>.sharepoint.com/sites/<site_name>.
  • To process all sites within a tenant, use a site URL of https://<tenant>-admin.sharepoint.com. This requires the app to be registered at a tenant level.

  Learn more.

• The path in the SharePoint site from which to start parsing files, for example "Shared Documents". If the connector is to process all sites within the tenant, this filter will be applied to all site document libraries.

• A SharePoint app principal with its application (client) ID, client secret, and access permissions to the SharePoint instance. Get a client ID and client secret, and set access permissions.

  You can create SharePoint app principals through https://<tenant>.sharepoint.com/_layouts/15/appregnew.aspx.

  For a SharePoint app principal with site-scoped permissions, use app permission request XML such as the following to grant permissions through https://<tenant>.sharepoint.com/_layouts/15/appinv.aspx:

  <AppPermissionRequests AllowAppOnlyPolicy="true">
    <AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="FullControl" />
  </AppPermissionRequests>
  

  For a SharePoint app principal with tenant-scoped permissions, use app permission request XML such as the following to grant permissions through https://<tenant>-admin.sharepoint.com/_layouts/15/appinv.aspx instead:

  <AppPermissionRequests AllowAppOnlyPolicy="true">
    <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" />
  </AppPermissionRequests>
  

  Available Right settings include Read, Write, Manage, and FullControl. To learn more, see Add-in permissions in SharePoint.

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_APP_CLIENT_ID - The SharePoint application (client) ID, represented by --client-id (CLI) or client_id (Python).
• SHAREPOINT_APP_CLIENT_SECRET - The client secret for the SharePoint application, represented by --client-cred (CLI) or client_cred (Python).
• SHAREPOINT_SITE - The SharePoint site URL, represented by --site (CLI) or site (Python).
• SHAREPOINT_PATH - The path in the SharePoint site from which to start parsing files, represented by --path (CLI) or path (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.