|
13 | 13 | - A Pinecone API key. [Get an API key](https://docs.pinecone.io/guides/get-started/authentication#find-your-pinecone-api-key).
|
14 | 14 | - A Pinecone serverless index. [Create a serverless index](https://docs.pinecone.io/guides/indexes/create-an-index).
|
15 | 15 |
|
| 16 | + An existing index is not required. At runtime, the index behavior is as follows: |
| 17 | + |
| 18 | + For the [Unstructured Platform](/platform/overview): |
| 19 | + |
| 20 | + - If an existing index name is specified, and Unstructured generates embeddings, |
| 21 | + but the number of dimensions that are generated does not match the existing index's embedding settings, the run will fail. |
| 22 | + You must change your Unstructured embedding settings or your existing index's embedding settings to match, and try the run again. |
| 23 | + - If an index name is not specified, Unstructured creates a new index in your Pinecone account. If Unstructured generates embeddings, |
| 24 | + the new index's name will be `u<short-workflow-id>-<short-embedding-model-name>-<number-of-dimensions>`. |
| 25 | + If Unstructured does not generate embeddings, the new index's name will be `u<short-workflow-id`. |
| 26 | + |
| 27 | + For [Unstructured Ingest](/ingestion/overview): |
| 28 | + |
| 29 | + - If an existing index name is specified, and Unstructured generates embeddings, |
| 30 | + but the number of dimensions that are generated does not match the existing index's embedding settings, the run will fail. |
| 31 | + You must change your Unstructured embedding settings or your existing index's embedding settings to match, and try the run again. |
| 32 | + - If an index name is not specified, Unstructured creates a new index in your Pinecone account. The new index's name will be `unstructuredautocreated`. |
| 33 | + |
16 | 34 | <Note>
|
17 |
| - Unstructured recommends that all records in the target index have a field |
| 35 | + If you create a new index or use an existing one, Unstructured recommends that all records in the target index have a field |
18 | 36 | named `record_id` with a string data type.
|
19 | 37 | Unstructured can use this field to do intelligent document overwrites. Without this field, duplicate documents
|
20 | 38 | might be written to the index or, in some cases, the operation could fail altogether.
|
|
0 commit comments