mirror of
https://github.com/Unstructured-IO/unstructured.git
synced 2025-07-11 19:15:56 +00:00
adacd8e5b1
### Description * Update all existing connector docs to use new pipeline approach ### Additional changes: * Some defaults were set for the runners to match those in the configs to make those easy to handle, i.e. the biomed runner: ```python max_retries: int = 5, max_request_time: int = 45, decay: float = 0.3, ```
117 lines
4.1 KiB
ReStructuredText
117 lines
4.1 KiB
ReStructuredText
Salesforce
|
|
==========
|
|
Connect Salesforce to your preprocessing pipeline, and batch process Salesforce data using ``unstructured-ingest`` to store structured outputs locally on your filesystem.
|
|
|
|
First you'll need to install the Salesforce dependencies as shown here.
|
|
|
|
.. code:: shell
|
|
|
|
pip install "unstructured[salesforce]"
|
|
|
|
Run Locally
|
|
-----------
|
|
|
|
.. tabs::
|
|
|
|
.. tab:: Shell
|
|
|
|
.. code:: shell
|
|
|
|
unstructured-ingest \
|
|
salesforce \
|
|
--username "$SALESFORCE_USERNAME" \
|
|
--consumer-key "$SALESFORCE_CONSUMER_KEY" \
|
|
--private-key-path "$SALESFORCE_PRIVATE_KEY_PATH" \
|
|
--categories "EmailMessage,Account,Lead,Case,Campaign" \
|
|
--output-dir salesforce-output \
|
|
--num-processes 2 \
|
|
--recursive \
|
|
--verbose
|
|
|
|
.. tab:: Python
|
|
|
|
.. code:: python
|
|
|
|
import os
|
|
|
|
from unstructured.ingest.interfaces import PartitionConfig, ProcessorConfig, ReadConfig
|
|
from unstructured.ingest.runner import SalesforceRunner
|
|
|
|
if __name__ == "__main__":
|
|
runner = SalesforceRunner(
|
|
processor_config=ProcessorConfig(
|
|
verbose=True,
|
|
output_dir="salesforce-output",
|
|
num_processes=2,
|
|
),
|
|
read_config=ReadConfig(),
|
|
partition_config=PartitionConfig(),
|
|
)
|
|
runner.run(
|
|
username=os.getenv("SALESFORCE_USERNAME"),
|
|
consumer_key=os.getenv("SALESFORCE_CONSUMER_KEY"),
|
|
private_key_path=os.getenv("SALESFORCE_PRIVATE_KEY_PATH"),
|
|
categories=["EmailMessage", "Account", "Lead", "Case", "Campaign"],
|
|
recursive=True,
|
|
)
|
|
|
|
Run via the API
|
|
---------------
|
|
|
|
You can also use upstream connectors with the ``unstructured`` API. For this you'll need to use the ``--partition-by-api`` flag and pass in your API key with ``--api-key``.
|
|
|
|
.. tabs::
|
|
|
|
.. tab:: Shell
|
|
|
|
.. code:: shell
|
|
|
|
unstructured-ingest \
|
|
salesforce \
|
|
--username "$SALESFORCE_USERNAME" \
|
|
--consumer-key "$SALESFORCE_CONSUMER_KEY" \
|
|
--private-key-path "$SALESFORCE_PRIVATE_KEY_PATH" \
|
|
--categories "EmailMessage,Account,Lead,Case,Campaign" \
|
|
--output-dir salesforce-output \
|
|
--num-processes 2 \
|
|
--recursive \
|
|
--verbose
|
|
--partition-by-api \
|
|
--api-key "<UNSTRUCTURED-API-KEY>"
|
|
|
|
.. tab:: Python
|
|
|
|
.. code:: python
|
|
|
|
import os
|
|
|
|
from unstructured.ingest.interfaces import PartitionConfig, ProcessorConfig, ReadConfig
|
|
from unstructured.ingest.runner import SalesforceRunner
|
|
|
|
if __name__ == "__main__":
|
|
runner = SalesforceRunner(
|
|
processor_config=ProcessorConfig(
|
|
verbose=True,
|
|
output_dir="salesforce-output",
|
|
num_processes=2,
|
|
),
|
|
read_config=ReadConfig(),
|
|
partition_config=PartitionConfig(
|
|
partition_by_api=True,
|
|
api_key=os.getenv("UNSTRUCTURED_API_KEY"),
|
|
),
|
|
)
|
|
runner.run(
|
|
username=os.getenv("SALESFORCE_USERNAME"),
|
|
consumer_key=os.getenv("SALESFORCE_CONSUMER_KEY"),
|
|
private_key_path=os.getenv("SALESFORCE_PRIVATE_KEY_PATH"),
|
|
categories=["EmailMessage", "Account", "Lead", "Case", "Campaign"],
|
|
recursive=True,
|
|
)
|
|
|
|
Additionally, you will need to pass the ``--partition-endpoint`` if you're running the API locally. You can find more information about the ``unstructured`` API `here <https://github.com/Unstructured-IO/unstructured-api>`_.
|
|
|
|
For a full list of the options the CLI accepts check ``unstructured-ingest salesforce --help``.
|
|
|
|
NOTE: Keep in mind that you will need to have all the appropriate extras and dependencies for the file types of the documents contained in your data storage platform if you're running this locally. You can find more information about this in the `installation guide <https://unstructured-io.github.io/unstructured/installing.html>`_.
|