https://<tenant>.sharepoint.com/sites/<site-collection-name>
.https://<tenant>.sharepoint.com
.https://<tenant>-admin.sharepoint.com
.Documents
.
my-folder/my-subfolder
.
The following video shows how to get the site URL and a path within the site:
Sites.ReadWrite.All
(if both reading and writing are needed)
User.Read.All
Learn more.
https://login.microsoftonline.com
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.--partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
--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)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
--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)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
, representing your API key and API URL, respectively.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.