Skip to content

Commit 75824af

Browse files
authored
Platform: Fix lots of broken links (#497)
1 parent e31999f commit 75824af

File tree

88 files changed

+316
-270
lines changed

Some content is hidden

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

88 files changed

+316
-270
lines changed

examplecode/codesamples/api/huggingchat.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Query processed PDF with HuggingChat
33
---
44

5-
This example uses the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library) or the
5+
This example uses the [Unstructured Ingest Python library](/ingestion/python-ingest) or the
66
[Unstructured JavaScript/TypeScript SDK](/platform-api/partition-api/sdk-jsts) to send a PDF file to
77
the [Unstructured Platform Partition Endpoint](/platform-api/partition-api/overview) for processing. Unstructured processes the PDF and extracts the PDF's content.
88
This example then sends some of the content to [HuggingChat](https://huggingface.co/chat/), Hugging Face's open-source AI chatbot,
@@ -11,7 +11,7 @@ along with some queries about this content.
1111
To run this example, you'll need:
1212

1313
- The [hugchat](https://pypi.org/project/hugchat/) package for Python, or the [huggingface-chat](https://www.npmjs.com/package/huggingface-chat) package for JavaScript/TypeScript.
14-
- Your Unstructured API key and API URL. [Get an API key and API URL](/platform-api/parition-api/overview).
14+
- Your Unstructured API key and API URL. [Get an API key and API URL](/platform-api/partition-api/overview).
1515
- Your Hugging Face account's email address and account password. [Get an account](https://huggingface.co/join).
1616
- A PDF file for Unstructured to process. This example uses a sample PDF file containing the text of the United States Constitution,
1717
available for download from [https://constitutioncenter.org/media/files/constitution.pdf](https://constitutioncenter.org/media/files/constitution.pdf).
@@ -37,7 +37,7 @@ import HuggingChatTSExampleCode from '/snippets/examples/huggingchat.ts.mdx';
3737
</Accordion>
3838
<Accordion title="JavaScript/TypeScript SDK">
3939
<Warning>
40-
Unstructured recommends that you use the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library) instead.
40+
Unstructured recommends that you use the [Unstructured Ingest Python library](/ingestion/python-ingest) instead.
4141

4242
The Ingest Python library provides faster processing of larger individual files, and faster and easier processing of multiple files at a time in batches.
4343
</Warning>

examplecode/tools/langflow.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ To do this, you can:
246246

247247
- [Use Unstructured Ingest to create a pipeline](/ingestion/overview) that relies on any available
248248
[source connector](/ingestion/source-connectors/overview) to connect to
249-
[Astra DB](/ingestion/destination-connector/astradb). Run this pipeline outside of Langflow anytime you have new documents in that non-local source location that
249+
[Astra DB](/ingestion/destination-connectors/astradb). Run this pipeline outside of Langflow anytime you have new documents in that non-local source location that
250250
you want Unstructured to process and then insert the new processed data into Astra DB. Then, back in the Langflow project,
251251
use the **Playground** to ask additonal questions, which will now include the new data when generating answers.
252252

@@ -274,16 +274,16 @@ Or, [use Unstructured Ingest to create a pipeline](/ingestion/overview) that rel
274274
[source connector](/ingestion/source-connectors/overview) to connect to
275275
one of the following available vector stores that Langflow also supports:
276276

277-
- [Chroma DB](/ingestion/destination-connector/chroma)
278-
- [Couchbase](/ingestion/destination-connector/couchbase)
279-
- [Elasticsearch](/ingestion/destination-connector/elasticsearch)
280-
- [Milvus](/ingestion/destination-connector/milvus)
281-
- [MongoDB](/ingestion/destination-connector/mongodb)
282-
- [OpenSearch](/ingestion/destination-connector/opensearch)
283-
- [Pinecone](/ingestion/destination-connector/pinecone)
284-
- [Qdrant](/ingestion/destination-connector/qdrant)
285-
- [Vectara](/ingestion/destination-connector/vectara)
286-
- [Weaviate](/ingestion/destination-connector/weaviate)
277+
- [Chroma DB](/ingestion/destination-connectors/chroma)
278+
- [Couchbase](/ingestion/destination-connectors/couchbase)
279+
- [Elasticsearch](/ingestion/destination-connectors/elasticsearch)
280+
- [Milvus](/ingestion/destination-connectors/milvus)
281+
- [MongoDB](/ingestion/destination-connectors/mongodb)
282+
- [OpenSearch](/ingestion/destination-connectors/opensearch)
283+
- [Pinecone](/ingestion/destination-connectors/pinecone)
284+
- [Qdrant](/ingestion/destination-connectors/qdrant)
285+
- [Vectara](/ingestion/destination-connectors/vectara)
286+
- [Weaviate](/ingestion/destination-connectors/weaviate)
287287

288288
Run this pipeline outside of Langflow anytime you have new documents in the source location that
289289
you want Unstructured to process and then insert the new processed data into the vector store. Then, back in the Langflow project,

ingestion/ingest-cli.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Unstructured Ingest CLI enables you to use command-line scripts to send file
88
<Note>
99
The Unstructured Ingest CLI does not work with the Unstructured Platform API.
1010

11-
For information about the Unstructured Platform API, see the [Unstructured Platform API Overview](/platform/api/overview).
11+
For information about the Unstructured Platform API, see the [Unstructured Platform API Overview](/platform-api/api/overview).
1212
</Note>
1313

1414
## Installation
@@ -34,7 +34,7 @@ For additional installation options, see [Unstructured Ingest CLI](/ingestion/ov
3434
To call the Unstructured Ingest CLI, follow this calling pattern, where:
3535

3636
- `<source>` is the command name for one of the available [source](/ingestion/source-connectors/overview) (input) connectors, such as `local` for a local source location, `azure` for an Azure Storage account source, `s3` for an Amazon S3 bucket source, and so on.
37-
- `<destination>` is the command name for one of the available [destination](/ingestion/destination-connector/overview) (output) connectors, such as `local` for a local destination, `azure` for an Azure Storage account destination, `s3` for an Amazon S3 bucket destination, and so on.
37+
- `<destination>` is the command name for one of the available [destination](/ingestion/destination-connectors/overview) (output) connectors, such as `local` for a local destination, `azure` for an Azure Storage account destination, `s3` for an Amazon S3 bucket destination, and so on.
3838
- `<setting>` is one or more command-line options for specifying how and where Unstructured will ingest the files from the `<source>`, or how and where to deliver the processed data to the `<destination>`.
3939

4040
```bash CLI
@@ -51,6 +51,6 @@ unstructured-ingest \
5151
--<settingN> <valueN>
5252
```
5353

54-
To learn how to use the Unstructured Ingest CLI to work with a specific source (input) and destination (output) location, see the CLI script examples for the [source](/ingestion/source-connectors/overview) and [destination](/ingestion/destination-connector/overview) connectors that are available for you to choose from.
54+
To learn how to use the Unstructured Ingest CLI to work with a specific source (input) and destination (output) location, see the CLI script examples for the [source](/ingestion/source-connectors/overview) and [destination](/ingestion/destination-connectors/overview) connectors that are available for you to choose from.
5555

5656
See also the [ingest configuration](/ingestion/ingest-configuration/overview) settings for command-line options that enable you to further control how batches are sent and processed.

ingestion/ingest-dependencies.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ When you install the [Unstructured Ingest CLI](/ingestion/ingest-cli) and the
66
[Unstructured Ingest Python library](/ingestion/python-ingest) by running the command
77
`pip install unstructured-ingest` by itself, you get the following by default:
88

9-
- The [local source connector](/ingestion/source-connectors/local) and the [local destination connector](/ingestion/destination-connector/local).
9+
- The [local source connector](/ingestion/source-connectors/local) and the [local destination connector](/ingestion/destination-connectors/local).
1010
- Support for the following file types:
1111

1212
| File type |

ingestion/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ import GeneratePythonCodeExamples from '/snippets/ingestion/code-generator.mdx';
127127

128128
- [Ingest configuration](/ingestion/ingest-configuration/overview) settings enable you to control how batches are sent and processed.
129129
- [Source connectors](/ingestion/source-connectors/overview) enable you to send batches from local or remote locations to be ingested by Unstructured for processing.
130-
- [Destination connectors](/ingestion/destination-connector/overview) enable Unstructured to send the processed data to local or remote locations.
130+
- [Destination connectors](/ingestion/destination-connectors/overview) enable Unstructured to send the processed data to local or remote locations.
131131

132132
## See also
133133

ingestion/python-ingest.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Unstructured Ingest Python library enables you to use Python code to send fi
88
<Note>
99
The Unstructured Ingest Python library does not work with the Unstructured Platform API.
1010

11-
For information about the Unstructured Platform API, see the [Unstructured Platform API Overview](/platform/api/overview).
11+
For information about the Unstructured Platform API, see the [Unstructured Platform API Overview](/platform-api/api/overview).
1212
</Note>
1313

1414
The following 3-minute video shows how to use the Unstructured Ingest Python library to send multiple PDFs from a local directory in batches to be ingested by Unstructured for processing:
@@ -23,8 +23,6 @@ The following 3-minute video shows how to use the Unstructured Ingest Python lib
2323
allowfullscreen
2424
></iframe>
2525

26-
[Learn more](/overview#unstructured-ingest-python).
27-
2826
## Installation
2927

3028
One approach to get started quickly with the Unstructured Ingest Python library is to install Python and then run the following command:
@@ -39,7 +37,7 @@ import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-d
3937

4038
<AdditionalIngestDependencies />
4139

42-
For additional installation options, and information about v2 and v1 implementations in this library, see the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library) in the [Ingest](/ingestion/overview) section.
40+
For additional installation options, and information about v2 and v1 implementations in this library, see the [Unstructured Ingest Python library](/ingestion/python-ingest) in the [Ingest](/ingestion/overview) section.
4341

4442
<Info>To migrate from older, deprecated versions of the Ingest Python library that used `pip install unstructured`, see the [migration guide](/ingestion/overview#migration-guide).</Info>
4543

@@ -58,6 +56,6 @@ import AzureAPIPyV1 from '/snippets/destination_connectors/azure.v1.py.mdx';
5856

5957
</CodeGroup>
6058

61-
To learn how to use the Unstructured Ingest Python library to work with a specific source (input) and destination (output) location, see the Python code examples for the [source](/ingestion/source-connectors/overview) and [destination](/ingestion/destination-connector/overview) connectors that are available for you to choose from.
59+
To learn how to use the Unstructured Ingest Python library to work with a specific source (input) and destination (output) location, see the Python code examples for the [source](/ingestion/source-connectors/overview) and [destination](/ingestion/destination-connectors/overview) connectors that are available for you to choose from.
6260

6361
See also the [ingest configuration](/ingestion/ingest-configuration/overview) settings that enable you to further control how batches are sent and processed.

meta-prompt/llms.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -736,7 +736,7 @@ if __name__ == "__main__":
736736
).run()
737737
```
738738

739-
**Reference:** [Azure Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/azure)
739+
**Reference:** [Azure Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/azure)
740740

741741
2. DataBricks Volumes
742742

@@ -882,7 +882,7 @@ if __name__ == "__main__":
882882
).run()
883883
```
884884

885-
**Reference:** [Databricks Volumes Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/databricks-volumes)
885+
**Reference:** [Databricks Volumes Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/databricks-volumes)
886886

887887
3. Weaviate
888888

@@ -948,7 +948,7 @@ The Weaviate destination connector enables you to batch process and store struct
948948
}
949949
```
950950
- [Schema Reference](https://weaviate.io/developers/weaviate/config-refs/schema)
951-
- [Document Elements and Metadata](https://docs.unstructured.io/latform-api/partition-api/document-elements)
951+
- [Document Elements and Metadata](https://docs.unstructured.io/platform-api/partition-api/document-elements)
952952

953953
---
954954

@@ -1054,7 +1054,7 @@ if __name__ == "__main__":
10541054
).run()
10551055
```
10561056

1057-
**Reference:** [Weaviate Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/weaviate)
1057+
**Reference:** [Weaviate Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/weaviate)
10581058

10591059
4. Pinecone
10601060

@@ -1184,7 +1184,7 @@ if __name__ == "__main__":
11841184
- Ensure the Pinecone schema aligns with the data structure produced by Unstructured for smooth ingestion.
11851185
- This example uses the local source connector; you can replace it with other supported connectors as needed.
11861186

1187-
**Reference:** [Pinecone Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/pinecone)
1187+
**Reference:** [Pinecone Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/pinecone)
11881188

11891189
5. S3
11901190

@@ -1330,7 +1330,7 @@ if __name__ == "__main__":
13301330
- This example uses the local source connector; other connectors can be substituted.
13311331
- Use `--anonymous` for anonymous bucket access where applicable.
13321332

1333-
**Reference:** [S3 Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/s3)
1333+
**Reference:** [S3 Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/s3)
13341334

13351335
# Unstructured Ingest Best Practices
13361336

@@ -1539,7 +1539,7 @@ Partitioning strategies in Unstructured are used to preprocess documents like PD
15391539

15401540
---
15411541

1542-
**Learn More**: [Document Elements and Metadata](https://docs.unstructured.io/latform-api/partition-api/document-elements)
1542+
**Learn More**: [Document Elements and Metadata](https://docs.unstructured.io/platform-api/partition-api/document-elements)
15431543

15441544
5. Tables as HTML
15451545

meta-prompt/splits/2.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ if __name__ == "__main__":
238238
).run()
239239
```
240240

241-
**Reference:** [Azure Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/azure)
241+
**Reference:** [Azure Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/azure)
242242

243243
2. DataBricks Volumes
244244

@@ -384,7 +384,7 @@ if __name__ == "__main__":
384384
).run()
385385
```
386386

387-
**Reference:** [Databricks Volumes Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/databricks-volumes)
387+
**Reference:** [Databricks Volumes Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/databricks-volumes)
388388

389389
3. Weaviate
390390

@@ -450,7 +450,7 @@ The Weaviate destination connector enables you to batch process and store struct
450450
}
451451
```
452452
- [Schema Reference](https://weaviate.io/developers/weaviate/config-refs/schema)
453-
- [Document Elements and Metadata](https://docs.unstructured.io/latform-api/partition-api/document-elements)
453+
- [Document Elements and Metadata](https://docs.unstructured.io/platform-api/partition-api/document-elements)
454454

455455
---
456456

@@ -556,4 +556,4 @@ if __name__ == "__main__":
556556
).run()
557557
```
558558

559-
**Reference:** [Weaviate Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/weaviate)
559+
**Reference:** [Weaviate Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/weaviate)

meta-prompt/splits/3.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ if __name__ == "__main__":
126126
- Ensure the Pinecone schema aligns with the data structure produced by Unstructured for smooth ingestion.
127127
- This example uses the local source connector; you can replace it with other supported connectors as needed.
128128

129-
**Reference:** [Pinecone Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/pinecone)
129+
**Reference:** [Pinecone Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/pinecone)
130130

131131
5. S3
132132

@@ -272,7 +272,7 @@ if __name__ == "__main__":
272272
- This example uses the local source connector; other connectors can be substituted.
273273
- Use `--anonymous` for anonymous bucket access where applicable.
274274

275-
**Reference:** [S3 Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/s3)
275+
**Reference:** [S3 Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/s3)
276276

277277
# Unstructured Ingest Best Practices
278278

@@ -481,7 +481,7 @@ Partitioning strategies in Unstructured are used to preprocess documents like PD
481481

482482
---
483483

484-
**Learn More**: [Document Elements and Metadata](https://docs.unstructured.io/latform-api/partition-api/document-elements)
484+
**Learn More**: [Document Elements and Metadata](https://docs.unstructured.io/platform-api/partition-api/document-elements)
485485

486486
5. Tables as HTML
487487

open-source/core-functionality/embedding.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Embedding
44

55
The Unstructured open-source library does not offer built-in support for calling embedding providers to obtain embeddings for pieces of text.
66

7-
Alternatively, the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) and the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library)
7+
Alternatively, the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) and the [Unstructured Ingest Python library](/ingestion/python-ingest)
88
offer built-in support for calling embedding providers as part of an ingest pipeline. [Learn how](/platform-api/partition-api/embedding).
99

1010
Also, you can use common third-party tools and libraries to get embeddings for document elements' text within JSON files that are

0 commit comments

Comments
 (0)