Dropbox connectors: automatic refreshing of expired access tokens (#576)

Author: Paul-Cornell

api-reference/partition/api-parameters.mdx

@@ -1,5 +1,5 @@
 ---
-title: Platform Endpoint parameters
+title: Partition Endpoint parameters
 sidebarTitle: Endpoint parameters
 ---
 

api-reference/partition/chunking.mdx

@@ -29,7 +29,7 @@ import SharedChunkingStrategyByTitle from '/snippets/concepts/chunking-strategy-
 
 ### "by_page" chunking strategy
 
-Only available in Unstructured API and Platform.
+Only available in the Unstructured UI and API.
 
 The `by_page` chunking strategy ensures the content from different pages do not end up in the same chunk.
 When a new page is detected, the existing chunk is completed and a new one is started, even if the next element would fit in the

snippets/destination_connectors/dropbox.sh.mdx

@@ -17,7 +17,6 @@ unstructured-ingest \
     --partition-endpoint $UNSTRUCTURED_API_URL \
     --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" \
   dropbox \
-    --token $DROPBOX_ACCESS_TOKEN \
     --refresh-token $DROPBOX_REFRESH_TOKEN \
     --app-key $DROPBOX_APP_KEY \
     --app-secret $DROPBOX_APP_SECRET \

snippets/destination_connectors/dropbox.v2.py.mdx

@@ -41,7 +41,6 @@ if __name__ == "__main__":
         embedder_config=EmbedderConfig(embedding_provider="huggingface"),
         destination_connection_config=DropboxConnectionConfig(
             access_config=DropboxAccessConfig(
-                token=os.getenv("DROPBOX_ACCESS_TOKEN"),
                 refresh_token=os.getenv("DROPBOX_REFRESH_TOKEN"),
                 app_key=os.getenv("DROPBOX_APP_KEY"),
                 app_secret=os.getenv("DROPBOX_APP_SECRET")

snippets/general-shared-text/astradb.mdx

@@ -16,7 +16,7 @@ allowfullscreen
 
   An existing collection is not required. At runtime, the collection behavior is as follows:
 
-  For the [Unstructured Platform](/platform/overview):
+  For the [Unstructured UI](/ui/overview) and [Unstructured API](/api-reference/overview):
 
   - If an existing collection name is specified, and Unstructured generates embeddings, 
     but the number of dimensions that are generated does not match the existing collection's embedding settings, the run will fail. 

snippets/general-shared-text/dropbox-api-placeholders.mdx

@@ -1,4 +1,6 @@
 - `<name>` (_required_) - A unique name for this connector.
-- `<token>` - The value of the access token for the Dropbox app that is associated with the target app folder.
-- `<remote-url>` - The remote URL to the target subfolder inside of the app folder for the Dropbox app.
-- Set `recursive` to `true` to recursively process data from subfolders within the target subfolder. The default is `false` if not otherwise specified.
+- `<remote-url>` (_required_) - The remote URL to the target subfolder inside of the app folder for the Dropbox app.
+- Set `recursive` to `true` to recursively process data from subfolders within the target subfolder. The default is `false` if not otherwise specified.
+- `<app-key>` (_required_) - The app key for your Dropbox app. This allows Unstructured to automatically replace expired access tokens.
+- `<app-secret>` (_required_) - The app secret for your Dropbox app. This allows Unstructured automatically to replace expired access tokens. 
+- `<refresh-token>` (_required_) - The refresh token for the Dropbox app. This allows Unstructured to automatically replace expired access tokens. 

snippets/general-shared-text/dropbox-cli-api.mdx

@@ -11,9 +11,10 @@ import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-d
 The following environment variables:
 
 - `DROPBOX_REMOTE_URL` - The remote URL to the target subfolder inside of the app folder for the Dropbox app, represented by `--remote-url` (CLI) or `remote_url` (Python).
-- `DROPBOX_ACCESS_TOKEN` - The value of the access token for the Dropbox app that is associated with the target app folder, represented by `--token` (CLI) or `token` (Python).
+- `DROPBOX_ACCESS_TOKEN` - The value of the access token for the Dropbox app that is associated with the target app folder, represented by `--token` (CLI) or `token` (Python). 
+  Provide this only if for some reason you do not want Unstructured to automatically refresh expired access tokens. 
 
-To have Unstructured refresh expired Dropbox App access tokens on your behalf, you must also provide the following environment variables:
+To have Unstructured automatically refresh expired Dropbox App access tokens on your behalf, do not provide an access token. Instead, provide the following environment variables:
 
 - `DROPBOX_REFRESH_TOKEN` - The value of the refresh token for the corresponding access token, represented by `--refresh-token` (CLI) or `refresh_token` (Python).
 - `DROPBOX_APP_KEY` - The app key for the Dropbox app, represented by `--app-key` (CLI) or `app_key` (Python).

snippets/general-shared-text/dropbox-platform.mdx

@@ -3,4 +3,6 @@ Fill in the following fields:
 - **Name** (_required_): A unique name for this connector.
 - **Data URL** (_required_): The URL to the target subfolder inside of the app folder for the Dropbox app, starting with `dropbox://`.
 - **Recursive** (source connector only): Check this box to also process all child folders and their files within the subfolder.
-- **Access token** : The access token for the Dropbox app that is associated with the target app folder.
+- **App key** (_required_) - The app key for your Dropbox app. This allows Unstructured to automatically replace expired access tokens.
+- **Refresh token** (_required_) - The refresh token for the Dropbox app. This allows Unstructured to automatically replace expired access tokens. 
+- **App secret** (_required_) - The app secret for your Dropbox app. This allows Unstructured automatically to replace expired access tokens. 

snippets/general-shared-text/dropbox.mdx

@@ -35,11 +35,9 @@ allowfullscreen
       If you do not already have the corresponding refresh token for an existing access token, or if you lose a refresh token after you generate it, 
       you must generate a new access token and its corresponding refresh token.
 
-      For [Unstructured Ingest](/ingestion/overview), instead of continualy replacing expired access tokens yourself, you can have Unstructured do it for you as needed; just supply Unstructured 
-      with the original access token and its corresponding refresh token along with the Dropbox app's **App key** and **App secret** values. 
-      To learn how to supply these to Unstructured, look for mentions of "access token, "refresh token," "app key," and "app secret" in the connector settings later in this article.
-
-      For the [Unstructured UI](/ui/overview) or the [Unstructured API](/api-reference/overview), or if you want to otherwise use the refresh token to replace the expired access token yourself, currently you must manually replace expired access tokens.
+      Instead of continualy replacing expired access tokens yourself, you can have Unstructured do it for you as needed; just supply Unstructured 
+      with the refresh token along with the Dropbox app's **App key** and **App secret** values. 
+      To learn how to supply these to Unstructured, look for mentions of "refresh token," "app key," and "app secret" in the connector settings later in this article.
    </Warning>
 
 3. The app folder that your Dropbox app will use for access can be found in your Dropbox account under the `Apps` top-level folder. For example, if the value of the **App folder name** 
@@ -66,7 +64,7 @@ allowfullscreen
 
 Dropbox app access tokens are valid for **only four hours**. After this time, you can no longer use the expired access token.
 
-To replace an old, expired access token with a new, valid one, do the following:
+To have Unstructured automatically replace expired access tokens on your behalf, do the following:
 
 1. Get the app key and app secret values for your Dropbox app. To do this:
 
@@ -101,16 +99,25 @@ To replace an old, expired access token with a new, valid one, do the following:
 
 7. In the response, copy the following two values:
 
-   - The value of `access_token` (starting with the characters `sl`) is the new, valid access token. In your Dropbox connector settings, replace the old, 
-     expired access token value with this new, valid access token value.
-   - The value of `refresh_token` is the refresh token that you can use to replace this access token much faster and easier next time. 
+   - The value of `access_token` (starting with the characters `sl`) is the new, valid access token.
+   - The value of `refresh_token` is the refresh token that can be used to replace this access token much faster and easier next time. 
      If you lose this refresh token, you must go back to Step 2.
 
-   For [Unstructured Ingest](/ingestion/overview), if you want Unstructured to use this refresh token to automatically replace the expired access token instead of replacing it yourself, then 
-   simply supply Unstructured with these `access_token` and `refresh_token` values, along with the `<app-key>` and `<app-secret>` values 
-   as described earlier in this procedure, and then stop here.
+   For the [Unstructured UI](/ui/overview), if you want Unstructured to use this refresh token to automatically replace the expired access token instead of replacing it yourself, then 
+   add the following values to your connector settings, and then stop here:
+   
+   - Add the `refresh_token` value to the connector settings **Refresh token** field.
+   - Add the `<app-key>` value to the connector settings **App key** field.
+   - Add the `<app-secret>` value to the connector settings **App secret** field.
+
+   For the [Unstructured API](/api-reference/overview) and [Unstructured Ingest](/ingestion/overview), if you want Unstructured to use this refresh token to automatically replace the expired access token instead of replacing it yourself, then 
+   add the following values to your connector settings, and then stop here:
+
+   - Add the `refresh_token` value to the `refresh_token` parameter.
+   - Add the `<app-key>` value to the `app_key` parameter.
+   - Add the `<app-secret>` value to the connector settings `app_secret` parameter.
 
-8. For the [Unstructured UI](/ui/overview) or the [Unstructured API](/api-reference/overview), or if you want to otherwise use the refresh token to replace the expired access token yourself, make the following REST API call, replacing the following placeholders:
+8. If for some reason you need to manually replace the expired access token yourself instead of having Unstructured do it for you, you can use the refresh token that you just copied to get a new access token:
 
    - Replace `<refresh-token>` with the refresh token.
    - Replace `<app-key>` with the app key for your Dropbox app.

snippets/general-shared-text/pinecone.mdx

@@ -15,7 +15,7 @@
 
   An existing index is not required. At runtime, the index behavior is as follows:
 
-  For the [Unstructured Platform](/platform/overview):
+  For the [Unstructured UI](/ui/overview) and [Unstructured API](/api-reference/overview):
 
   - If an existing index name is specified, and Unstructured generates embeddings, 
     but the number of dimensions that are generated does not match the existing index's embedding settings, the run will fail.