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.
- A Pinecone account. Get an account.
- A Pinecone API key. Get an API key.
-
A Pinecone serverless index. Create a serverless index.
An existing index is not required. At runtime, the index behavior is as follows:
For the Unstructured UI and Unstructured API:
- If an existing index name is specified, and Unstructured generates embeddings, but the number of dimensions that are generated does not match the existing index’s embedding settings, the run will fail. You must change your Unstructured embedding settings or your existing index’s embedding settings to match, and try the run again.
- If an index name is not specified, Unstructured creates a new index in your Pinecone account. If Unstructured generates embeddings,
the new index’s name will be
u<short-workflow-id>-<short-embedding-model-name>-<number-of-dimensions>
. If Unstructured does not generate embeddings, the new index’s name will beu<short-workflow-id
.
- If an existing index name is specified, and Unstructured generates embeddings, but the number of dimensions that are generated does not match the existing index’s embedding settings, the run will fail. You must change your Unstructured embedding settings or your existing index’s embedding settings to match, and try the run again.
- If an index name is not specified, Unstructured creates a new index in your Pinecone account. The new index’s name will be
unstructuredautocreated
.
If you create a new index or use an existing one, Unstructured recommends that all records in the target index have a field namedrecord_id
with a string data type. Unstructured can use this field to do intelligent document overwrites. Without this field, duplicate documents might be written to the index or, in some cases, the operation could fail altogether. - Within a Pinecone serverless index, custom namespaces are supported but are not required.
<name>
(required) - A unique name for this connector.<index-name>
- The name of the index in the Pinecone database. If no value is provided, see the beginning of this article for the behavior at run time.<namespace-name>
- The name of any custom namespace in the Pinecone index to upsert data into. If no value is provided, the default namespace ofdefault
will be used.<api-key>
(required) - The Pinecone API key.<batch-size>
- The maximum number of records to transmit in a single batch. The default is50
unless otherwise specified.