If you’re new to Unstructured, read this note first.Before you can create a destination connector, you must first sign in to your Unstructured account:
- If you do not already have an Unstructured account, sign up for free. After you sign up, you are automatically signed in to your new Unstructured Starter account, at https://platform.unstructured.io. To sign up for a Team or Enterprise account instead, contact Unstructured Sales, or learn more.
- If you already have an Unstructured Starter or Team account and are not already signed in, sign in to your account at https://platform.unstructured.io. For an Enterprise account, see your Unstructured account administrator for instructions, or email Unstructured Support at support@unstructured.io.
-
After you sign in to your Unstructured Starter account, click API Keys on the sidebar.
For a Team or Enterprise account, before you click API Keys, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. Learn more. -
Click Generate API Key.
-
Follow the on-screen instructions to finish generating the key.
-
Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
- 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:
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:
- The self-managed instance’s hostname and port number. See Networking.
- If you’re using basic authentication to the self-managed instance, the user’s name and password.
- If you’re using token-based authentication to the self-managed instance, the bearer token or API key for the instance. See Token-based authentication services and Create API key.
- If you’re using certificate authentication to the self-managed instance, the path to the Certificate Authority (CA) file on the instance, and the certificate fingerprint. See SSL certificate API and Where can I see my Certificate Fingerprint?.
<name>
(required) - A unique name for this connector.hosts
is a required array, with<host-url>
specifying the URL of the Elastic Cloud instance to access, for example:["https://<random-number>.<region>.<cloud-provider>.cloud.es.io"]
.<es-api-key>
(required) - The Elastic Cloud API key for the target cluster.<index-name>
(required) - The name of the target index in the cluster.