Skip to content

Commit 00f544f

Browse files
fix: improve doc code (#2920)
Improves the documentation code. Standardizes unstructured api key Replaces misc hard coded values Replaces `azureunstructured1` with a generic value
1 parent df1f7bc commit 00f544f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+94
-83
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion

docs/source/ingest/destination_connectors/code/bash/azure.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ unstructured-ingest \
1212
--num-processes 2 \
1313
--verbose \
1414
azure \
15-
--account-name azureunstructured1 \
15+
--account-name "$AZURE_ACCOUNT_NAME" \
1616
--remote-url "<your destination path here, ie 'az://unstructured/war-and-peace-output'>"

docs/source/ingest/destination_connectors/code/bash/clarifai.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ unstructured-ingest \
99
--num-processes 2 \
1010
--verbose \
1111
clarifai \
12-
--app-id "<your clarifai app name>" \
13-
--user-id "<your clarifai user id>" \
14-
--api-key "<your clarifai PAT key>" \
12+
--app-id "$CLARIFAI_APP_ID" \
13+
--user-id "$CLARIFAI_USER_ID" \
14+
--api-key "$CLARIFAI_PAT_KEY" \
1515
--batch-size 100

docs/source/ingest/destination_connectors/code/bash/qdrant.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ unstructured-ingest \
1212
--num-processes 2 \
1313
--verbose \
1414
qdrant \
15-
--collection-name "test" \
15+
--collection-name "$QDRANT_COLLECTION_NAME" \
1616
--location "http://localhost:6333" \
1717
--batch-size 80

docs/source/ingest/destination_connectors/code/python/azure.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import os
2+
13
from unstructured.ingest.connector.fsspec.azure import (
24
AzureAccessConfig,
35
AzureWriteConfig,
@@ -21,7 +23,7 @@
2123
def get_writer() -> Writer:
2224
return AzureWriter(
2325
connector_config=SimpleAzureBlobStorageConfig(
24-
access_config=AzureAccessConfig(account_name="azureunstructured1"),
26+
access_config=AzureAccessConfig(account_name=os.getenv("AZURE_ACCOUNT_NAME")),
2527
remote_url="az://unstructured/war-and-peace-output",
2628
),
2729
write_config=AzureWriteConfig(),

docs/source/ingest/destination_connectors/code/python/clarifai.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import os
2+
13
from unstructured.ingest.connector.clarifai import (
24
ClarifaiAccessConfig,
35
ClarifaiWriteConfig,
@@ -20,9 +22,9 @@
2022
def get_writer() -> Writer:
2123
return ClarifaiWriter(
2224
connector_config=SimpleClarifaiConfig(
23-
access_config=ClarifaiAccessConfig(api_key="CLARIFAI_PAT"),
24-
app_id="CLARIFAI_APP",
25-
user_id="CLARIFAI_USER_ID",
25+
access_config=ClarifaiAccessConfig(api_key=os.getenv("CLARIFAI_PAT_KEY")),
26+
app_id=os.getenv("CLARIFAI_APP_ID"),
27+
user_id=os.getenv("CLARIFAI_USER_ID"),
2628
),
2729
write_config=ClarifaiWriteConfig(),
2830
)

docs/source/ingest/source_connectors/code/bash/airtable_api.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ unstructured-ingest \
88
--num-processes 2 \
99
--reprocess \
1010
--partition-by-api \
11-
--api-key "<UNSTRUCTURED-API-KEY>"
11+
--api-key "$UNSTRUCTURED_API_KEY"

docs/source/ingest/source_connectors/code/bash/azure.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
unstructured-ingest \
44
azure \
55
--remote-url abfs://container1/ \
6-
--account-name azureunstructured1 \
6+
--account-name "$AZURE_ACCOUNT_NAME" \
77
--output-dir azure-ingest-output \
88
--num-processes 2

docs/source/ingest/source_connectors/code/bash/azure_api.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
unstructured-ingest \
44
azure \
55
--remote-url abfs://container1/ \
6-
--account-name azureunstructured1 \
6+
--account-name "$AZURE_ACCOUNT_NAME" \
77
--output-dir azure-ingest-output \
88
--num-processes 2 \
99
--partition-by-api \
10-
--api-key "<UNSTRUCTURED-API-KEY>"
10+
--api-key "$UNSTRUCTURED_API_KEY"

docs/source/ingest/source_connectors/code/bash/biomed_api.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ unstructured-ingest \
88
--verbose \
99
--preserve-downloads \
1010
--partition-by-api \
11-
--api-key "<UNSTRUCTURED-API-KEY>"
11+
--api-key "$UNSTRUCTURED_API_KEY"

0 commit comments

Comments
 (0)