Vectara

Batch process all your records to store structured outputs in Vectara.

The requirements are as follows.

• 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.

The Vectara connector dependencies.

pip install "unstructured-ingest[vectara]"

You might also need to install additional dependencies, depending on your needs. Learn more.

The following environment variables:

• VECTARA_CUSTOMER_ID - The customer ID for the target Vectara account, represented by --customer-id (CLI) or customer_id (Python).
• VECTARA_CORPUS_NAME - The name of the target corpus in the account, represented by --corpus-name (CLI) or corpus_name (Python).
• VECTARA_CORPUS_KEY - The name of the corpus’s key, represented by --corpus-key (CLI) or corpus_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) or token_url (Python).
• VECTARA_OAUTH_CLIENT_ID - A valid OAuth client ID in the account, represented by --oauth-client-id (CLI) or oauth_client_id (Python).
• VECTARA_OAUTH_CLIENT_SECRET - The OAuth client secret for the client ID, represented by --oauth-client-secret (CLI) or oauth_client_secret (Python).

Now call the Unstructured CLI or Python SDK. The source connector can be any of the ones supported.

This example uses the local source connector.

This example sends files to Unstructured for processing by default. To process files locally instead, see the instructions at the end of this page.

CLI

#!/usr/bin/env bash

# Chunking and embedding is optional.

unstructured-ingest \
  local \
    --input-path $LOCAL_FILE_INPUT_DIR \
    --chunking-strategy by_title \
    --embedding-provider huggingface \
    --partition-by-api \
    --api-key $UNSTRUCTURED_API_KEY \
    --partition-endpoint $UNSTRUCTURED_API_URL \
    --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" \
  vectara \
    --customer-id $VECTARA_CUSTOMER_ID \
    --corpus-name $VECTARA_CORPUS_NAME \
    --corpus-key $VECTARA_CORPUS_KEY \
    --oauth-client-id $VECTARA_OAUTH_CLIENT_ID \
    --oauth-secret $VECTARA_OAUTH_CLIENT_SECRET \
    --token-url $VECTARA_OAUTH_TOKEN_URL

For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you can use the --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) 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)
  • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_API_URL

• To send files to the Unstructured Partition Endpoint for processing, specify --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)
  • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_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, for example, if you are using a self-hosted instance of the Unstructured API.

  The default API URL for Unstructured Ingest is https://api.unstructuredapp.io/general/v0/general, which is the API URL for the Unstructured Partition Endpoint.

  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 [e-mail].