Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt

Use this file to discover all available pages before exploring further.

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:After you sign in, the Unstructured user interface (UI) appears, which you use to get your Unstructured API key, as follows:
  1. After you sign in to your Unstructured Let’s Go, Pay-As-You-Go, or Business account, click API Keys on the sidebar.
     For a Business 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.
  2. Click Generate API Key.
  3. Follow the on-screen instructions to finish generating the key.
  4. 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.
After you create the source connector, add it along with a destination connector to a workflow. Then run the worklow as a job. To learn how, try out the the notebook Dropbox-To-Pinecone Connector API Quickstart for Unstructured, or watch the two 4-minute video tutorials for the Unstructured Python SDK.You can also create source connectors with the Unstructured user interface (UI). Learn how.If you need help, email Unstructured Support at support@unstructured.io.You are now ready to start creating a source connector! Keep reading to learn how.
Ingest your files into Unstructured from Couchbase.

​
Requirements

You will need:
For Couchbase Capella, you will need: 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.

​
Examples

To create a Couchbase source connector, see the following examples. For more information on working with source connectors using the Unstructured API, see Source endpoints. 
import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import CreateSourceConnector

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.sources.create_source(
        request=CreateSourceRequest(
            create_source_connector=CreateSourceConnector(
                name="<name>",
                type="couchbase",
                config={
                    "username": "<username>",
                    "bucket": "<bucket>",
                    "connection_string": "<connection-string>",
                    "scope": "<scope>",
                    "collection": "<collection>",
                    "password": "<password>",
                    "batch_size": <batch-size>,
                    "collection_id": "<collection-id>"
                }
            )
        )
    )

    print(response.source_connector_information)

​
Configuration settings

Replace the preceding placeholders as follows:
​
name
string
required
A unique name for this connector.
​
username
string
required
The username for the Couchbase server.
​
bucket
string
required
The name of the bucket in the Couchbase server.
​
connection_string
string
required
The connection string for the Couchbase server.
​
scope
string
default:"_default"
The name of the scope in the bucket.
​
collection
string
default:"_default"
The name of the collection in the scope.
​
password
string
required
The password for the Couchbase server.
​
batch_size
integer
default:"50"
The maximum number of records to transmit per batch.
​
collection_id
string
default:"id"
Source connector only. The name of the collection field that contains the document ID.

​
Learn more