Account
, Campaign
, Case
, EmailMessage
, and Lead
.
.crt
) and private key (.pem
) files
that you will associate with the connected app.
If you do not have the certificate and private key files, you can use the openssl
utility on your local machine to create your own
private key and self-signed certificate, if your organization allows, by running the following commands, one command at a time:
https://localhost
is okay if you won’t be using this connected app for other special authentication scenarios.
.crt
) file.
<client-id>
with the consumer key value. This URL assumes that the callback URL
is https://localhost
:
.pem
) file to Unstructured as
a string that contains the contents of the file (not the private key file itself).<path-to-private-key-file>
with the path to the private key file.
SALESFORCE_USERNAME
- The Salesforce username that has access to the required Salesforce categories, represented by --username
(CLI) or username
(Python).SALESFORCE_CONSUMER_KEY
- The consumer key (client ID) for the Salesforce connected app, represented by --consumer-key
(CLI) or consumer_key
(Python).SALESFORCE_PRIVATE_KEY
- The contents of the private key (PEM) associated with the consumer key for the Salesforce connected app, represented by --private-key
(CLI) or private_key
(Python), orSALESFORCE_PRIVATE_KEY_PATH
- The local path to the (PEM) associated with the consumer key for the Salesforce connected app, represented by --private-key-path
(CLI) or private_key_path
(Python).--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.