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 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 beU<short-workflow-id
.
- 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
Unstructuredautocreated
.
<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 astext
,type
,element_id
,record_id
, and so on. The embeddings will be returned in thevector
property.
record_id
property, 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.