Skip to main content
FileNet Couchbase is a Distributed NoSQL Cloud Database. Couchbase embraces AI with coding assistance for developers, and vector search for their applications. Batch process all your records to store structured outputs in a Couchbase database. The requirements are as follows. To access the information you’ll need to configure the connector:
  1. Log into your account.
  2. Choose the Navigator tile. The IBM Navigator launches in a separate browser window, and provides a view of your object stores and content. You can use the IBM Navigator views to find the information necessary to create a connection to Unstructured. For the URL of your IBM FileNet server:
    • The server URL displays in the browser address bar. You only need the base URL that specifies the company and domain. For example, https://<company-name>.automationcloud.ibm.com.
    For object store names and folder paths:
    • Select the folder in the left pane. The full folder path is displayed at the top of the main detail pane, in the following format: <object-store>/<folder>/etc.
    For the document class:
    • Right-click the document and select Properties.
    For the account username:
    • Right-click the profile icon on the upper right in the top menu.
The FileNet connector dependencies:
CLI, Python
pip install "unstructured-ingest[filenet]"
You might also need to install additional dependencies, depending on your needs. Learn more. These environment variables are required for the IBM FileNet connector:
  • FILENET_SERVER_URL - The URL of your Content Platform Engine,, represented by --server-url (CLI) or server_url (Python).
  • FILENET_OBJECT_STORE - The name of object store in the IBM FileNet server, represented by --object-store (CLI) or object_store (Python).
  • FILENET_FOLDER_PATH - The path of the folder within the object store, represented by --folder-path (CLI) or folder_path (Python).
  • FILENET_DOCUMENT_CLASS - The document class of documents contained in the folder, represented by --document-class (CLI) or document_class (Python).
  • FILENET_RECURSIVE - true to include subfolders, represented by --recursive (CLI) or recursive (Python).
  • FILENET_USERNAME - The username for the IBM Cloud Pak for Business Automation as a Service account, represented by --username (CLI) or username (Python).
  • FILENET_PASSWORD - The password for the corresponding username, represented by --password (CLI) or password (Python).
Additional available settings include:
  • --collection-id (CLI) or collection_id in CouchbaseDownloaderConfig (Python) - Optional for the source connector. The
    unique key of the ID field in the collection. The default is id if not otherwise specified. Learn more.
Now call the Unstructured Ingest CLI or the Unstructured Ingest Python library. The source connector can be any of the ones supported. This example uses the local source connector. This example sends files to Unstructured for processing by default. To process files locally instead, see the instructions at the end of this page. 
#!/usr/bin/env bash

# Chunking and embedding are optional.

unstructured-ingest \
  local \
    --input-path $LOCAL_FILE_INPUT_DIR \
    --output-dir $LOCAL_FILE_OUTPUT_DIR \
    --strategy hi_res \
    --chunk-elements \
    --embedding-provider huggingface \
    --num-processes 2 \
    --verbose \
    --partition-by-api \
    --api-key $UNSTRUCTURED_API_KEY \
    --partition-endpoint $UNSTRUCTURED_API_URL \
    --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" \
  filenet \
    --username $FILENET_USERNAME \
    --password $FILENET_PASSWORD \
    --server-url $FILENET_SERVER_URL \
    --object-store $FILENET_OBJECT_STORE \
    --folder-path $FILENET_FOLDER_PATH \
    --document-class $FILENET_DOCUMENT_CLASS \
    --recursive $FILENET_RECURSIVE \
    --num-processes 2 \
    --batch-size 80
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)
    • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_API_URL
  • To send files to the legacy 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)
    • The environment variables 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, which applies to Let’s Go, Pay-As-You-Go, and Business SaaS accounts.The default API URL for Unstructured Ingest is https://api.unstructuredapp.io/general/v0/general, which is the API URL for the legacyUnstructured 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, email Unstructured Support at support@unstructured.io.If you do not have an API key, get one now.If you are using a Business account, the process for generating Unstructured API keys, and the Unstructured API URL that you use, are different. For instructions, see your Unstructured account administrator, or email Unstructured Support at support@unstructured.io.