Astra DB

Connect Astra DB 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.

• An Astra account. Create or sign in to an Astra account.
• A database in the Astra account. Create a database in an account.
• An application token for the database. Create a database application token.
• A namespace in the database. Create a namespace in a database.
• A collection in the namespace. Create a collection in a namespace.

The Astra DB connector dependencies:

pip install "unstructured-ingest[astradb]"

You might also need to install additional dependencies, depending on your needs. Learn more.

These environment variables:

• ASTRA_DB_API_ENDPOINT - The API endpoint for the Astra DB database, represented by --api-endpoint (CLI) or api_endpoint (Python). To get the endpoint, see the Database Details > API Endpoint value on your database’s Overview tab.
• ASTRA_DB_APPLICATION_TOKEN - The database application token value for the database, represented by --token (CLI) or token (Python). To get the token, see the Database Details > Application Tokens box on your database’s Overview tab.
• ASTRA_DB_KEYSPACE - The name of the keyspace for the database, represented by --keyspace (CLI) or keyspace (Python).
• ASTRA_DB_COLLECTION - The name of the collection for the keyspace, represented by --collection-name (CLI) or collection_name (Python).

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 API services for processing by default. To process data 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)
  • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_API_URL

• To send files to Unstructured API services for processing, specify --partition-by-api (CLI) or partition_by_api=True (Python).

  Unstructured API services 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.

  Get an API key and API URL.