If you’re new to Unstructured, read this note first.Before you can create a source connector, you must first sign in to your Unstructured account:
- If you do not already have an Unstructured account, sign up for free. After you sign up, you are automatically signed in to your new Unstructured Starter account, at https://platform.unstructured.io. To sign up for a Team or Enterprise account instead, contact Unstructured Sales, or learn more.
- If you already have an Unstructured Starter or Team account and are not already signed in, sign in to your account at https://platform.unstructured.io. For an Enterprise account, see your Unstructured account administrator for instructions, or email Unstructured Support at support@unstructured.io.
-
After you sign in to your Unstructured Starter account, click API Keys on the sidebar.
For a Team or Enterprise account, before you click API Keys, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. Learn more. -
Click Generate API Key.
-
Follow the on-screen instructions to finish generating the key.
-
Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
- For the Unstructured UI or the Unstructured API, only Couchbase Capella clusters are supported.
- For Unstructured Ingest, Couchbase Capella clusters and local Couchbase server deployments are supported.
- A Couchbase Capella account.
- A Couchbase Capella cluster.
- A bucket, scope, and collection on the cluster.
- The cluster’s public connection string.
- The cluster access name (username) and secret (password).
-
Incoming IP address allowance for the cluster.
To get Unstructured’s IP address ranges, go to
https://assets.p6m.u10d.net/publicitems/ip-prefixes.json
and allow all of the
ip_prefix
fields’ values that are listed.These IP address ranges are subject to change. You can always find the latest ones in the preceding file.
- Installation of a local Couchbase server.
- Connection details to the local Couchbase server.
<name>
(required) - A unique name for this connector.<username>
(required) - The username for the Couchbase server.<bucket>
(required) - The name of the bucket in the Couchbase server.<connection-string>
(required) - The connection string for the Couchbase server.<scope>
- The name of the scope in the bucket. The default is_default
if not otherwise specified.<collection>
- The name of the collection in the scope. The default is_default
if not otherwise specified.<password>
(required) - The password for the Couchbase server.<batch-size>
- The maximum number of records to transmit per batch. The default is50
if not otherwise specified.<collection-id>
(source connector only) - The name of the collection field that contains the document ID. The default isid
if not otherwise specified.