u<short-workflow-id>-<short-embedding-model-name>-<number-of-dimensions>
.
If Unstructured does not generate embeddings, the new index’s name will be u<short-workflow-id
.unstructuredautocreated
.record_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.PINECONE_API_KEY
- The Pinecone API, represented by --api-key
(CLI) or api_key
(Python, in the PineconeAccessConfig
object).PINECONE_INDEX_NAME
- The Pinecone serverless index name, represented by --index-name
(CLI) or index_name
(Python). If no value is provided, see the beginning of this article for the behavior at run time.PINECONE_NAMESPACE_NAME
- The name of any custom namespace in the Pinecone index to upsert data into, represented by --namespace
(CLI) or namespace
(Python). If no value is provided, the default namespace of default
will be used.--partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
--partition-by-api
(CLI) or partition_by_api
(Python), or explicitly specify partition_by_api=False
(Python).
Local file processing does not use an Unstructured API key or API URL, so you can also omit the following, if they appear:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
--partition-by-api
(CLI) or partition_by_api=True
(Python).
Unstructured also requires an Unstructured API key and API URL, by adding the following:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
, representing your API key and API URL, respectively.https://api.unstructuredapp.io/general/v0/general
, which is the API URL for the Unstructured Partition Endpoint. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at sales@unstructured.io.If you do not have an API key, get one now.If the Unstructured API is self-hosted, the process
for generating Unstructured API keys, and the Unstructured API URL that you use, are different.
For details, contact Unstructured Sales at
sales@unstructured.io.