u<short-workflow-id>_<short-embedding-model-name>_<number-of-dimensions>
.
If Unstructured does not generate embeddings, the new collections’s name will be u<short-workflow-id
.unstructuredautocreated
.ASTRA_DB_API_ENDPOINT
- The API endpoint for the Astra DB database, represented by --api-endpoint
(CLI) or api_endpoint
(Python). To get the endpoint, see the Database Details > API Endpoint value on your database’s Overview tab.ASTRA_DB_APPLICATION_TOKEN
- The database application token value for the database, represented by --token
(CLI) or token
(Python). To get the token, see the Database Details > Application Tokens box on your database’s Overview tab.ASTRA_DB_KEYSPACE
- The name of the keyspace for the database, represented by --keyspace
(CLI) or keyspace
(Python).ASTRA_DB_COLLECTION
- The name of the collection for the keyspace, represented by --collection-name
(CLI) or collection_name
(Python). If no value is provided, see the beginning of this article for the behavior at run time.--fields
(CLI) or fields
(Python): Optionally, a comma-separated list (CLI) or an array of strings (Python) of fields
to include in the output. The default is ti include all fields, if not otherwise specified.--flatten-metadata
(CLI) or flatten_metadata=True
(Python): Optionally, whether to “flatten” the metadata. Specifically, the metadata key values are
brought to the top level of the element, and the metadata
key itself is removed. To not flatten the metadata (the default), specify --no-flatten_metadata
(CLI) or
flatten_metadata=False
(Python). The default is is to not flatten the metadata if not otherwise specified.--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.