- A Vectara account.
- The customer ID for the account.
- The name and key for the target corpus in the account.
- The OAuth authentication URL, client ID, and client secret for accessing the target corpus.
VECTARA_CUSTOMER_ID
- The customer ID for the target Vectara account, represented by--customer-id
(CLI) orcustomer_id
(Python).VECTARA_CORPUS_NAME
- The name of the target corpus in the account, represented by--corpus-name
(CLI) orcorpus_name
(Python).VECTARA_CORPUS_KEY
- The name of the corpus’s key, represented by--corpus-key
(CLI) orcorpus_key
(Python).VECTARA_OAUTH_TOKEN_URL
- The OAuth token URL for getting and refreshing OAuth access tokens in the account, represented by--token-url
(CLI) ortoken_url
(Python).VECTARA_OAUTH_CLIENT_ID
- A valid OAuth client ID in the account, represented by--oauth-client-id
(CLI) oroauth_client_id
(Python).VECTARA_OAUTH_CLIENT_SECRET
- The OAuth client secret for the client ID, represented by--oauth-client-secret
(CLI) oroauth_client_secret
(Python).
--partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
-
To do local file processing, omit
--partition-by-api
(CLI) orpartition_by_api
(Python), or explicitly specifypartition_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) orapi_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) orpartition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)- The environment variables
UNSTRUCTURED_API_KEY
andUNSTRUCTURED_API_URL
-
To send files to the Unstructured Partition Endpoint for processing, specify
--partition-by-api
(CLI) orpartition_by_api=True
(Python). Unstructured also requires an Unstructured API key and API URL, by adding the following:--api-key $UNSTRUCTURED_API_KEY
(CLI) orapi_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) orpartition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)- The environment variables
UNSTRUCTURED_API_KEY
andUNSTRUCTURED_API_URL
, representing your API key and API URL, respectively.
You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, which applies to Starter and Team accounts.The default API URL for Unstructured Ingest ishttps://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, email Unstructured Support at support@unstructured.io.If you do not have an API key, get one now.If you are using an Enterprise account, the process for generating Unstructured API keys, and the Unstructured API URL that you use, are different. For instructions, see your Unstructured account administrator, or email Unstructured Support at support@unstructured.io.