Connect Couchbase Database to your preprocessing pipeline, and use the Unstructured Ingest CLI or the Unstructured Ingest Python library to batch process all your documents and store structured outputs locally on your filesystem.
The requirements are as follows.
For Couchbase Capella, you will need:
A bucket, scope, and collection on the cluster.
The cluster’s public connection string.
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.
For a local Couchbase server, you will need:
To learn more about how to set up a Couchbase cluster and play with data, refer to this tutorial.
The Couchbase DB connector dependencies:
You might also need to install additional dependencies, depending on your needs. Learn more.
These environment variables are required for the Couchbase Connector:
CB_CONN_STR
- The Connection String for the Couchbase server, represented by --connection-string
(CLI) or connection_string
(Python).CB_USERNAME
- The username for the Couchbase server, represented by --username
(CLI) or username
(Python).CB_PASSWORD
- The password for the Couchbase server, represented by --password
(CLI) or password
(Python).CB_BUCKET
- The name of the bucket in the Couchbase server, represented by --bucket
(CLI) or bucket
(Python).CB_SCOPE
- The name of the scope in the bucket, represented by --scope
(CLI) or scope
(Python).CB_COLLECTION
- The name of the collection in the scope, represented by --collection
(CLI) or collection
(Python).Additional available settings include:
--collection-id
(CLI) or collection_id
in CouchbaseDownloaderConfig
(Python) - Optional for the source connector. Theid
if not otherwise specified.
Learn more.Now call the Unstructured CLI or Python. The destination connector can be any of the ones supported. This example uses the local destination connector:
This example sends data to Unstructured for processing by default. To process files locally instead, see the instructions at the end of this page.
For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you can use the --partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
To do local file processing, omit --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
To send files to the Unstructured Partition Endpoint for processing, specify --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.You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, for example, if you are using a self-hosted instance of the Unstructured API.
The default API URL for Unstructured Ingest is 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.
Connect Couchbase Database to your preprocessing pipeline, and use the Unstructured Ingest CLI or the Unstructured Ingest Python library to batch process all your documents and store structured outputs locally on your filesystem.
The requirements are as follows.
For Couchbase Capella, you will need:
A bucket, scope, and collection on the cluster.
The cluster’s public connection string.
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.
For a local Couchbase server, you will need:
To learn more about how to set up a Couchbase cluster and play with data, refer to this tutorial.
The Couchbase DB connector dependencies:
You might also need to install additional dependencies, depending on your needs. Learn more.
These environment variables are required for the Couchbase Connector:
CB_CONN_STR
- The Connection String for the Couchbase server, represented by --connection-string
(CLI) or connection_string
(Python).CB_USERNAME
- The username for the Couchbase server, represented by --username
(CLI) or username
(Python).CB_PASSWORD
- The password for the Couchbase server, represented by --password
(CLI) or password
(Python).CB_BUCKET
- The name of the bucket in the Couchbase server, represented by --bucket
(CLI) or bucket
(Python).CB_SCOPE
- The name of the scope in the bucket, represented by --scope
(CLI) or scope
(Python).CB_COLLECTION
- The name of the collection in the scope, represented by --collection
(CLI) or collection
(Python).Additional available settings include:
--collection-id
(CLI) or collection_id
in CouchbaseDownloaderConfig
(Python) - Optional for the source connector. Theid
if not otherwise specified.
Learn more.Now call the Unstructured CLI or Python. The destination connector can be any of the ones supported. This example uses the local destination connector:
This example sends data to Unstructured for processing by default. To process files locally instead, see the instructions at the end of this page.
For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you can use the --partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
To do local file processing, omit --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
To send files to the Unstructured Partition Endpoint for processing, specify --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.You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, for example, if you are using a self-hosted instance of the Unstructured API.
The default API URL for Unstructured Ingest is 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.