If you’re new to Unstructured, read this note first.

Before you can create a destination connector, you must first sign up for Unstructured and get your Unstructured API key. After you sign up, the Unstructured user interface (UI) appears, which you use to get the key. To learn how, watch this 40-second how-to video.

After you create the destination connector, add it along with a source connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.

You can also create destination connectors with the Unstructured user interface (UI). Learn how.

If you need help, reach out to the community on Slack, or contact us directly.

You are now ready to start creating a destination connector! Keep reading to learn how.

Send processed data from Unstructured to Weaviate.

The requirements are as follows.

  • For the Unstructured UI or the Unstructured API: only Weaviate Cloud clusters are supported.

  • For Unstructured Ingest: Weaviate Cloud clusters, Weaviate installed locally, and Embedded Weaviate are supported.

  • For Weaviate installed locally, you will need the name of the target collection on the local instance.

  • For Embedded Weaviate, you will need the instance’s connection URL and the name of the target collection on the instance.

  • For Weaviate Cloud, you will need:

    • 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.

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

    • The name of the target collection in the database. Create a collection.

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

      For the Unstructured UI or the Unstructured API:

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

      For Unstructured Ingest:

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

      If Unstructured creates a new collection and generates embeddings, you will not see an embeddings property in tools such as the Weaviate Cloud Collections user interface. To view the generated embeddings, you can run a Weaviate GraphQL query such as the following. In this query, replace <collection-name> with the name of the new collection, and replace <property-name> with the name of each additional available property that you want to return results for, such as text, type, element_id, record_id, and so on. The embeddings will be returned in the vector property.

      {
  Get {
    <collection-name> {
      _additional {
        vector
      }
      <property-name>
      <property-name>
    }
  }
}

Weaviate requires an existing collection to have a data schema before you add data. At minimum, this schema must contain the record_id property, as follows:

{
    "class": "Elements",
    "properties": [
        {
            "name": "record_id",
            "dataType": ["text"]
        }
    ]
}

Weaviate generates any additional properties based on the incoming data.

If you have specific schema requirements, you can define the schema manually. 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 specific schema requirements:

{
    "class": "Elements",
    "properties": [
        {
            "name": "record_id",
            "dataType": ["text"]
        },
        {
            "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"]
                },
                {
                    "name": "partitioner_type",
                    "dataType": ["text"]
                }
            ]
        }
    ]
}

See also :

To create a Weaviate destination connector, see the following examples.

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateDestinationRequest
from unstructured_client.models.shared import (
    CreateDestinationConnector,
    DestinationConnectorType,
    WeaviateDestinationConnectorConfigInput
)

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.destinations.create_destination(
        request=CreateDestinationRequest(
            create_destination_connector=CreateDestinationConnector(
                name="<name>",
                type=DestinationConnectorType.WEAVIATE_CLOUD,
                config=WeaviateDestinationConnectorConfigInput(
                    cluster_url="<host-url>",
                    collection="<class-name>",
                    api_key="<api-key>"
                )
            )
        )
    )

    print(response.destination_connector_information)

Replace the preceding placeholders as follows:

  • <name> (required) - A unique name for this connector.
  • <host-url> (required) - The URL of the Weaviate database cluster.
  • <class-name> - The name of the target collection within the cluster. If no value is provided, see the beginning of this article for the behavior at run time.
  • <api-key> (required) - The API key provided by Weaviate to access the cluster.

Was this page helpful?

Suggest edits