This page was recently updated. What do you think about it? Let us know!.

Batch process all your records to store structured outputs in a Weaviate database.

You will need:

The Weaviate prerequisites:

  1. A Weaviate database instance. The following information assumes that you have a Weaviate Cloud (WCD) account with a Weaviate database cluster in that account. Create a WCD account. Create a database cluster. For other database options, learn more.

  2. The URL and API key for the database cluster. Get the URL and API key.

  3. A collection in the database cluster. Note the name of the collection, also known as the collection’s class name. Create a collection.

    The schema of the collection that you use must match the data that Unstructured writes to it. Otherwise, you might get unexpected results or errors. Unstructured cannot provide a schema that is guaranteed to work for everyone in all circumstances. This is because these schemas will vary based on your source files’ types; how you want Unstructured to partition, chunk, and generate embeddings; any custom post-processing code that you run; and other factors.

    You can adapt the following collection schema example for your own needs:

    {
    "class": "Elements",
    "properties": [
        {
            "name": "element_id",
            "dataType": ["text"]
        },
        {
            "name": "text",
            "dataType": ["text"]
        },
        {
            "name": "embeddings",
            "dataType": ["number[]"]
        },
        {
            "name": "metadata",
            "dataType": ["object"],
            "nestedProperties": [
                {
                    "name": "parent_id",
                    "dataType": ["text"]
                },
                {
                    "name": "page_number",
                    "dataType": ["text"]
                },
                {
                    "name": "is_continuation",
                    "dataType": ["boolean"]
                },
                {
                    "name": "orig_elements",
                    "dataType": ["text"]
                }
            ]
        }
    ]
}

    See also :

The Weaviate connector dependencies:

CLI, Python
pip install "unstructured-ingest[weaviate]"

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

The following environment variables:

  • WEAVIATE_URL - THE REST endpoint for the Weaviate database cluster, represented by --host-url (CLI) or host_url (Python).

  • WEAVIATE_API_KEY - The API key for the database cluster, represented by --api-key (CLI) or api_key (Python).

    For the CLI, the --api-key option here is part of the weaviate command. For Python, the api_key parameter here is part of the WeaviateAccessConfig object.

  • WEAVIATE_COLLECTION_CLASS_NAME - The name of the collection in the database, represented by --class-name (CLI) or class_name (Python).

These environment variables:

  • UNSTRUCTURED_API_KEY - Your Unstructured API key value.
  • UNSTRUCTURED_API_URL - Your Unstructured API URL.

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:

Was this page helpful?

VectaraChoose a partitioning strategy