Batch process all your records to store structured outputs in Pinecone.

The requirements are as follows.

  • A Pinecone account. Get an account.

  • A Pinecone API key. Get an API key.

  • A Pinecone serverless index. Create a serverless index.

    An existing index is not required. At runtime, the index behavior is as follows:

    For the Unstructured UI and Unstructured API:

    • If an existing index name is specified, and Unstructured generates embeddings, but the number of dimensions that are generated does not match the existing index’s embedding settings, the run will fail. You must change your Unstructured embedding settings or your existing index’s embedding settings to match, and try the run again.
    • If an index name is not specified, Unstructured creates a new index in your Pinecone account. If Unstructured generates embeddings, the new index’s name will be u<short-workflow-id>-<short-embedding-model-name>-<number-of-dimensions>. If Unstructured does not generate embeddings, the new index’s name will be u<short-workflow-id.

    For Unstructured Ingest:

    • If an existing index name is specified, and Unstructured generates embeddings, but the number of dimensions that are generated does not match the existing index’s embedding settings, the run will fail. You must change your Unstructured embedding settings or your existing index’s embedding settings to match, and try the run again.
    • If an index name is not specified, Unstructured creates a new index in your Pinecone account. The new index’s name will be unstructuredautocreated.

    If you create a new index or use an existing one, Unstructured recommends that all records in the target index have a field named record_id with a string data type. Unstructured can use this field to do intelligent document overwrites. Without this field, duplicate documents might be written to the index or, in some cases, the operation could fail altogether.

  • Within a Pinecone serverless index, custom namespaces are supported but are not required.

The Pinecone connector dependencies.

pip install "unstructured-ingest[pinecone]"

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

The following environment variables:

  • PINECONE_API_KEY - The Pinecone API, represented by --api-key (CLI) or api_key (Python, in the PineconeAccessConfig object).
  • PINECONE_INDEX_NAME - The Pinecone serverless index name, represented by --index-name (CLI) or index_name (Python). If no value is provided, see the beginning of this article for the behavior at run time.
  • PINECONE_NAMESPACE_NAME - The name of any custom namespace in the Pinecone index to upsert data into, represented by --namespace (CLI) or namespace (Python). If no value is provided, the default namespace of default will be used.

Now call the Unstructured CLI or Python SDK. 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 \
    --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}" \
  pinecone \
    --api-key "$PINECONE_API_KEY" \
    --index-name "$PINECONE_INDEX_NAME" \
    --namespace "$PINECONE_NAMESPACE_NAME" \
    --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 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, 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.