diff --git a/dropbox/.env-template b/dropbox/.env-template index 42f4361f1..7af04fffe 100644 --- a/dropbox/.env-template +++ b/dropbox/.env-template @@ -3,4 +3,8 @@ DROPBOX_APP_KEY= DROPBOX_APP_SECRET= DROPBOX_SEARCH_LIMIT=5 DROPBOX_PATH= -DROPBOX_CONNECTOR_API_KEY= \ No newline at end of file +DROPBOX_CONNECTOR_API_KEY= + +# Unstructured +DROPBOX_UNSTRUCTURED_BASE_URL= +DROPBOX_UNSTRUCTURED_API_KEY= \ No newline at end of file diff --git a/dropbox/README.md b/dropbox/README.md index e38690cb1..66f142816 100644 --- a/dropbox/README.md +++ b/dropbox/README.md @@ -6,8 +6,6 @@ This package is a utility for connecting Cohere to Dropbox, featuring a simple l The Dropbox connector currently searches for all active files within your Dropbox instance. Note that new files added will require a couple minutes of indexing time to be searchable. Dropbox usually takes less than 5 minutes. -**Please note, currently, the contents of individual files is not decoded.** - ## Configuration To use the Dropbox connector, first create an app in the [Developer App Console](https://www.dropbox.com/developers/apps). Select Scoped Access, and give it the access type it needs. Note that `App folder` access will give your app access to a folder specifically created for your app, while `Full Dropbox` access will give your app access to all files and folders currently in your Dropbox instance. @@ -60,6 +58,17 @@ curl -X POST \ }' ``` +## Unstructured + +To decode file contents, this connector leverages [Unstructured](https://unstructured.io). You can generate a free [API key here](https://unstructured.io/api-key). + +It is necessary to provide the following values in the `.env`: + +- `DROPBOX_UNSTRUCTURED_BASE_URL` +- `DROPBOX_UNSTRUCTURED_API_KEY` + +Use the API key generated earlier. To quickstart usage, you can use the hosted `https://api.unstructured.io` as the base URL, or you can [host your own Unstructured server](https://unstructured-io.github.io/unstructured/apis/usage_methods.html). + ## Development Create a virtual environment and install dependencies with poetry. We recommend using in-project virtual environments: