Skip to content

Commit

Permalink
Update readme and .env
Browse files Browse the repository at this point in the history
  • Loading branch information
tianjing-li committed Dec 6, 2023
1 parent e5c64dc commit 12151c3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
6 changes: 5 additions & 1 deletion dropbox/.env-template
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,8 @@ DROPBOX_APP_KEY=
DROPBOX_APP_SECRET=
DROPBOX_SEARCH_LIMIT=5
DROPBOX_PATH=
DROPBOX_CONNECTOR_API_KEY=
DROPBOX_CONNECTOR_API_KEY=

# Unstructured
DROPBOX_UNSTRUCTURED_BASE_URL=
DROPBOX_UNSTRUCTURED_API_KEY=
13 changes: 11 additions & 2 deletions dropbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 12151c3

Please sign in to comment.