Join

Microsoft SharePoint

This documents covers how to download the documents from Sharepoint.

Pre-requisites:

Register an application with the Microsoft identity platform and create the client_id, client_secret and tenant_id.

Setup:

Access Microsoft share-point in azure portal:

• Go to Azure Portal Microsoft Azure and Login with username and password

• Go to azure service -> App registrations → New registration Enter the name and fill the details , click registration

• Then Go go certificates and secrets generate secret ids.

• Next provide app permissions (Site Permissions)

To create a sharepoint connection with credentials

CLIENT_ID = '<client_id>'
CLIENT_SECRET = '<client_secret>'
TENANT_ID = '<tenant_id>'
SCOPE = 'https://graph.microsoft.com/.default'
HOST_NAME = "<tenant_name>.sharepoint.com"

from semantic_ai.connectors import Sharepoint
sharepoint = Sharepoint(
        client_id = CLIENT_ID,
        client_secret = CLIENT_SECRET,
        tenant_id = TENANT_ID,
        scope = SCOPE,
        host_name = HOST_NAME
)
# To connect the particular site
site_obj = await sharepoint.connect(site_name)

To list the all sites

list_sites = await sharepoint.list_sites()

To list the drives in the particular site

drives = await sharepoint.list_drives(site_id)

To list the root folders and files

folders = await sharepoint.list_folders(site_id, drive_id)

To download the files from particular folder

We need a folder path ‘data/accounts’ to make a request for download.

await sharepoint.download(site_id, drive_id, folder_path)

By default output directory name download_file_dir

We can change the output directory with simply pass output_dir param

from semantic_ai.connectors import Sharepoint
sharepoint = Sharepoint(
        client_id = CLIENT_ID,
        client_secret = CLIENT_SECRET,
        tenant_id = TENANT_ID,
        scope = SCOPE,
        host_name = HOST_NAME,
        output_dir="<path-to-download>"
)