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:

  • If you do not already have an Unstructured account, go to https://unstructured.io/contact and fill out the online form to indicate your interest.
  • If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at sales@unstructured.io.

After you sign in, the Unstructured user interface (UI) appears, which you use to create your source connector.

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 hands-on UI quickstart or watch the 4-minute video tutorial.

You can also create source connectors with the Unstructured API. 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 source connector! Keep reading to learn how.

Ingest your files into Unstructured from Elasticsearch.

The requirements are as follows.

  • For the Unstructured UI or the Unstructured API, only Elastic Cloud instances are supported.

  • For Unstructured Ingest, Elastic Cloud instances and self-manged Elasticsearch instances are supported.

  • For Elastic Cloud, you will need an Elastic Cloud service instance.

  • For self-managed Elasticsearch, you will need a self-managed Elasticsearch instance.

  • You will need the name of the index on the instance. See Create index and Get index.

    The Elasticsearch index that you use must have a schema that is compatible with the schema of the documents that Unstructured produces for you. Unstructured cannot provide a schema that is guaranteed to work 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 index schema example for your own needs:

    {
    "settings": {
        "index": {
            "knn": true,
            "knn.algo_param.ef_search": 100
        }
    },
    "mappings": {
        "properties": {
            "record_id": {
                "type": "text"
            },
            "element_id": {
                "type": "keyword"
            },
            "text": {
                "type": "text"
            },
            "embeddings": {
                "type": "dense_vector",
                "dims": 384,
                "index": true,
                "similarity": "cosine"
            },
            "metadata": {
                "type": "object",
                "properties": {
                    "parent_id": {
                        "type": "text"
                    },
                    "page_number": {
                        "type": "integer"
                    },
                    "is_continuation": {
                        "type": "boolean"
                    },
                    "orig_elements": {
                        "type": "text"
                    },
                    "partitioner_type": {
                        "type": "text"
                    }
                }
            }
        }
    }
}

    See also:

  • For Elastic Cloud, you will need the Elastic Cloud service instance’s API key. If you are using Unstructured Ingest, you will also need the instance’s Cloud ID. To get these, see your Elasticsearch Service web console.

  • For self-managed Elasticsearch, you will need:

To create the source connector:

  1. On the sidebar, click Connectors.
  2. Click Sources.
  3. Cick New or Create Connector.
  4. Give the connector some unique Name.
  5. In the Provider area, click Elasticsearch.
  6. Click Continue.
  7. Follow the on-screen instructions to fill in the fields as described later on this page.
  8. Click Save and Test.

Fill in the following fields:

  • Name (required): A unique name for this connector.
  • Host (required): The endpoint URL for the target cluster.
  • Index Name (required): The name of the target index in the cluster.
  • API Key (required): The Elastic Cloud API key for the target cluster.