This page was recently updated. What do you think about it? Let us know!.
Connect GitLab to your preprocessing pipeline, and use the Unstructured CLI or Python to batch process all your documents and store structured outputs locally on your filesystem. The requirements are as follows.
  • A GitLab account.
  • The URL for the target GitLab repository.
  • A GitLab access token that allows access to the repository.
  • Optionally, the name of a specific branch to access in the repository. The repository’s default repository branch is used if not otherwise specified.
  • Optionally, a list of file globs to limit which types of files are accepted, for example *.html or *.txt.
The GitLab connector dependencies:
CLI, Python
pip install "unstructured-ingest[gitlab]"
You might also need to install additional dependencies, depending on your needs. Learn more. The following environment variables:
  • GITLAB_REPO_URL - The URL for the target GitLab repository, represented by --url (CLI) or url (Python).
  • GITLAB_TOKEN - The GitLab access token that allows access to the repository, represented by --git-access-token (CLI) or access_token (Python).
Now call the Unstructured CLI or Python. The destination connector can be any of the ones supported. This example uses the local destination connector. This example sends data to Unstructured for processing by default. To process data locally instead, see the instructions at the end of this page. 
#!/usr/bin/env bash

# Chunking and embedding are optional.

unstructured-ingest \
  gitlab \
  --url $GITLAB_URL \
  --git-access-token $GITLAB_TOKEN \
  --git-branch v0.0.7 \
  --git-file-glob "*.html,*.txt" \
  --output-dir $LOCAL_FILE_OUTPUT_DIR \
  --partition-by-api \
  --api-key $UNSTRUCTURED_API_KEY \
  --partition-endpoint $UNSTRUCTURED_API_URL \
  --strategy hi_res \
  --chunking-strategy by_title \
  --embedding-provider huggingface \
  --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}"
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, which applies to Starter and Team accounts.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. 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.