diff --git a/examplecode/codesamples/api/huggingchat.mdx b/examplecode/codesamples/api/huggingchat.mdx index 67e28b04..992197c3 100644 --- a/examplecode/codesamples/api/huggingchat.mdx +++ b/examplecode/codesamples/api/huggingchat.mdx @@ -2,7 +2,7 @@ title: Query processed PDF with HuggingChat --- -This example uses the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library) or the +This example uses the [Unstructured Ingest Python library](/ingestion/python-ingest) or the [Unstructured JavaScript/TypeScript SDK](/platform-api/partition-api/sdk-jsts) to send a PDF file to the [Unstructured Platform Partition Endpoint](/platform-api/partition-api/overview) for processing. Unstructured processes the PDF and extracts the PDF's content. 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. To run this example, you'll need: - 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. -- Your Unstructured API key and API URL. [Get an API key and API URL](/platform-api/parition-api/overview). +- Your Unstructured API key and API URL. [Get an API key and API URL](/platform-api/partition-api/overview). - Your Hugging Face account's email address and account password. [Get an account](https://huggingface.co/join). - A PDF file for Unstructured to process. This example uses a sample PDF file containing the text of the United States Constitution, 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'; - Unstructured recommends that you use the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library) instead. + Unstructured recommends that you use the [Unstructured Ingest Python library](/ingestion/python-ingest) instead. The Ingest Python library provides faster processing of larger individual files, and faster and easier processing of multiple files at a time in batches. diff --git a/examplecode/tools/langflow.mdx b/examplecode/tools/langflow.mdx index ce409cd5..d86a8f32 100644 --- a/examplecode/tools/langflow.mdx +++ b/examplecode/tools/langflow.mdx @@ -246,7 +246,7 @@ To do this, you can: - [Use Unstructured Ingest to create a pipeline](/ingestion/overview) that relies on any available [source connector](/ingestion/source-connectors/overview) to connect to - [Astra DB](/ingestion/destination-connector/astradb). Run this pipeline outside of Langflow anytime you have new documents in that non-local source location that + [Astra DB](/ingestion/destination-connectors/astradb). Run this pipeline outside of Langflow anytime you have new documents in that non-local source location that you want Unstructured to process and then insert the new processed data into Astra DB. Then, back in the Langflow project, use the **Playground** to ask additonal questions, which will now include the new data when generating answers. @@ -274,16 +274,16 @@ Or, [use Unstructured Ingest to create a pipeline](/ingestion/overview) that rel [source connector](/ingestion/source-connectors/overview) to connect to one of the following available vector stores that Langflow also supports: -- [Chroma DB](/ingestion/destination-connector/chroma) -- [Couchbase](/ingestion/destination-connector/couchbase) -- [Elasticsearch](/ingestion/destination-connector/elasticsearch) -- [Milvus](/ingestion/destination-connector/milvus) -- [MongoDB](/ingestion/destination-connector/mongodb) -- [OpenSearch](/ingestion/destination-connector/opensearch) -- [Pinecone](/ingestion/destination-connector/pinecone) -- [Qdrant](/ingestion/destination-connector/qdrant) -- [Vectara](/ingestion/destination-connector/vectara) -- [Weaviate](/ingestion/destination-connector/weaviate) +- [Chroma DB](/ingestion/destination-connectors/chroma) +- [Couchbase](/ingestion/destination-connectors/couchbase) +- [Elasticsearch](/ingestion/destination-connectors/elasticsearch) +- [Milvus](/ingestion/destination-connectors/milvus) +- [MongoDB](/ingestion/destination-connectors/mongodb) +- [OpenSearch](/ingestion/destination-connectors/opensearch) +- [Pinecone](/ingestion/destination-connectors/pinecone) +- [Qdrant](/ingestion/destination-connectors/qdrant) +- [Vectara](/ingestion/destination-connectors/vectara) +- [Weaviate](/ingestion/destination-connectors/weaviate) Run this pipeline outside of Langflow anytime you have new documents in the source location that you want Unstructured to process and then insert the new processed data into the vector store. Then, back in the Langflow project, diff --git a/ingestion/ingest-cli.mdx b/ingestion/ingest-cli.mdx index 9ee1f790..7b5d2696 100644 --- a/ingestion/ingest-cli.mdx +++ b/ingestion/ingest-cli.mdx @@ -8,7 +8,7 @@ The Unstructured Ingest CLI enables you to use command-line scripts to send file The Unstructured Ingest CLI does not work with the Unstructured Platform API. - For information about the Unstructured Platform API, see the [Unstructured Platform API Overview](/platform/api/overview). + For information about the Unstructured Platform API, see the [Unstructured Platform API Overview](/platform-api/api/overview). ## Installation @@ -34,7 +34,7 @@ For additional installation options, see [Unstructured Ingest CLI](/ingestion/ov To call the Unstructured Ingest CLI, follow this calling pattern, where: - `` 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. -- `` 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. +- `` 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. - `` is one or more command-line options for specifying how and where Unstructured will ingest the files from the ``, or how and where to deliver the processed data to the ``. ```bash CLI @@ -51,6 +51,6 @@ unstructured-ingest \ -- ``` -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. +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. 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. \ No newline at end of file diff --git a/ingestion/ingest-dependencies.mdx b/ingestion/ingest-dependencies.mdx index 75e79f13..0d5dcd61 100644 --- a/ingestion/ingest-dependencies.mdx +++ b/ingestion/ingest-dependencies.mdx @@ -6,7 +6,7 @@ When you install the [Unstructured Ingest CLI](/ingestion/ingest-cli) and the [Unstructured Ingest Python library](/ingestion/python-ingest) by running the command `pip install unstructured-ingest` by itself, you get the following by default: -- The [local source connector](/ingestion/source-connectors/local) and the [local destination connector](/ingestion/destination-connector/local). +- The [local source connector](/ingestion/source-connectors/local) and the [local destination connector](/ingestion/destination-connectors/local). - Support for the following file types: | File type | diff --git a/ingestion/overview.mdx b/ingestion/overview.mdx index d952c11c..fc1483c3 100644 --- a/ingestion/overview.mdx +++ b/ingestion/overview.mdx @@ -127,7 +127,7 @@ import GeneratePythonCodeExamples from '/snippets/ingestion/code-generator.mdx'; - [Ingest configuration](/ingestion/ingest-configuration/overview) settings enable you to control how batches are sent and processed. - [Source connectors](/ingestion/source-connectors/overview) enable you to send batches from local or remote locations to be ingested by Unstructured for processing. -- [Destination connectors](/ingestion/destination-connector/overview) enable Unstructured to send the processed data to local or remote locations. +- [Destination connectors](/ingestion/destination-connectors/overview) enable Unstructured to send the processed data to local or remote locations. ## See also diff --git a/ingestion/python-ingest.mdx b/ingestion/python-ingest.mdx index a5b0c6da..3f1fe85f 100644 --- a/ingestion/python-ingest.mdx +++ b/ingestion/python-ingest.mdx @@ -8,7 +8,7 @@ The Unstructured Ingest Python library enables you to use Python code to send fi The Unstructured Ingest Python library does not work with the Unstructured Platform API. - For information about the Unstructured Platform API, see the [Unstructured Platform API Overview](/platform/api/overview). + For information about the Unstructured Platform API, see the [Unstructured Platform API Overview](/platform-api/api/overview). 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 allowfullscreen > -[Learn more](/overview#unstructured-ingest-python). - ## Installation 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 -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. +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. To migrate from older, deprecated versions of the Ingest Python library that used `pip install unstructured`, see the [migration guide](/ingestion/overview#migration-guide). @@ -58,6 +56,6 @@ import AzureAPIPyV1 from '/snippets/destination_connectors/azure.v1.py.mdx'; -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. +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. See also the [ingest configuration](/ingestion/ingest-configuration/overview) settings that enable you to further control how batches are sent and processed. \ No newline at end of file diff --git a/meta-prompt/llms.txt b/meta-prompt/llms.txt index 7c06ae96..365268e9 100644 --- a/meta-prompt/llms.txt +++ b/meta-prompt/llms.txt @@ -736,7 +736,7 @@ if __name__ == "__main__": ).run() ``` -**Reference:** [Azure Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/azure) +**Reference:** [Azure Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/azure) 2. DataBricks Volumes @@ -882,7 +882,7 @@ if __name__ == "__main__": ).run() ``` -**Reference:** [Databricks Volumes Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/databricks-volumes) +**Reference:** [Databricks Volumes Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/databricks-volumes) 3. Weaviate @@ -948,7 +948,7 @@ The Weaviate destination connector enables you to batch process and store struct } ``` - [Schema Reference](https://weaviate.io/developers/weaviate/config-refs/schema) - - [Document Elements and Metadata](https://docs.unstructured.io/latform-api/partition-api/document-elements) + - [Document Elements and Metadata](https://docs.unstructured.io/platform-api/partition-api/document-elements) --- @@ -1054,7 +1054,7 @@ if __name__ == "__main__": ).run() ``` -**Reference:** [Weaviate Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/weaviate) +**Reference:** [Weaviate Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/weaviate) 4. Pinecone @@ -1184,7 +1184,7 @@ if __name__ == "__main__": - Ensure the Pinecone schema aligns with the data structure produced by Unstructured for smooth ingestion. - This example uses the local source connector; you can replace it with other supported connectors as needed. -**Reference:** [Pinecone Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/pinecone) +**Reference:** [Pinecone Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/pinecone) 5. S3 @@ -1330,7 +1330,7 @@ if __name__ == "__main__": - This example uses the local source connector; other connectors can be substituted. - Use `--anonymous` for anonymous bucket access where applicable. -**Reference:** [S3 Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/s3) +**Reference:** [S3 Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/s3) # Unstructured Ingest Best Practices @@ -1539,7 +1539,7 @@ Partitioning strategies in Unstructured are used to preprocess documents like PD --- -**Learn More**: [Document Elements and Metadata](https://docs.unstructured.io/latform-api/partition-api/document-elements) +**Learn More**: [Document Elements and Metadata](https://docs.unstructured.io/platform-api/partition-api/document-elements) 5. Tables as HTML diff --git a/meta-prompt/splits/2.txt b/meta-prompt/splits/2.txt index c0b3a8af..377e90e6 100644 --- a/meta-prompt/splits/2.txt +++ b/meta-prompt/splits/2.txt @@ -238,7 +238,7 @@ if __name__ == "__main__": ).run() ``` -**Reference:** [Azure Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/azure) +**Reference:** [Azure Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/azure) 2. DataBricks Volumes @@ -384,7 +384,7 @@ if __name__ == "__main__": ).run() ``` -**Reference:** [Databricks Volumes Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/databricks-volumes) +**Reference:** [Databricks Volumes Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/databricks-volumes) 3. Weaviate @@ -450,7 +450,7 @@ The Weaviate destination connector enables you to batch process and store struct } ``` - [Schema Reference](https://weaviate.io/developers/weaviate/config-refs/schema) - - [Document Elements and Metadata](https://docs.unstructured.io/latform-api/partition-api/document-elements) + - [Document Elements and Metadata](https://docs.unstructured.io/platform-api/partition-api/document-elements) --- @@ -556,4 +556,4 @@ if __name__ == "__main__": ).run() ``` -**Reference:** [Weaviate Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/weaviate) \ No newline at end of file +**Reference:** [Weaviate Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/weaviate) \ No newline at end of file diff --git a/meta-prompt/splits/3.txt b/meta-prompt/splits/3.txt index 8048cee5..efdece9d 100644 --- a/meta-prompt/splits/3.txt +++ b/meta-prompt/splits/3.txt @@ -126,7 +126,7 @@ if __name__ == "__main__": - Ensure the Pinecone schema aligns with the data structure produced by Unstructured for smooth ingestion. - This example uses the local source connector; you can replace it with other supported connectors as needed. -**Reference:** [Pinecone Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/pinecone) +**Reference:** [Pinecone Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/pinecone) 5. S3 @@ -272,7 +272,7 @@ if __name__ == "__main__": - This example uses the local source connector; other connectors can be substituted. - Use `--anonymous` for anonymous bucket access where applicable. -**Reference:** [S3 Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connector/s3) +**Reference:** [S3 Destination Connector Documentation](https://docs.unstructured.io/ingestion/destination-connectors/s3) # Unstructured Ingest Best Practices @@ -481,7 +481,7 @@ Partitioning strategies in Unstructured are used to preprocess documents like PD --- -**Learn More**: [Document Elements and Metadata](https://docs.unstructured.io/latform-api/partition-api/document-elements) +**Learn More**: [Document Elements and Metadata](https://docs.unstructured.io/platform-api/partition-api/document-elements) 5. Tables as HTML diff --git a/open-source/core-functionality/embedding.mdx b/open-source/core-functionality/embedding.mdx index 0bab8552..1a84313e 100644 --- a/open-source/core-functionality/embedding.mdx +++ b/open-source/core-functionality/embedding.mdx @@ -4,7 +4,7 @@ title: Embedding The Unstructured open-source library does not offer built-in support for calling embedding providers to obtain embeddings for pieces of text. -Alternatively, the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) and the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library) +Alternatively, the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) and the [Unstructured Ingest Python library](/ingestion/python-ingest) offer built-in support for calling embedding providers as part of an ingest pipeline. [Learn how](/platform-api/partition-api/embedding). Also, you can use common third-party tools and libraries to get embeddings for document elements' text within JSON files that are diff --git a/open-source/core-functionality/staging.mdx b/open-source/core-functionality/staging.mdx index 45721288..431de600 100644 --- a/open-source/core-functionality/staging.mdx +++ b/open-source/core-functionality/staging.mdx @@ -4,7 +4,7 @@ title: Staging -The `Staging` brick is being deprecated in favor of the new and more comprehensive `Destination Connectors`. To explore the complete list and usage, please refer to [Destination Connectors documentation](../ingest/destination-connectors/overview). +The `Staging` brick is being deprecated in favor of the new and more comprehensive `Destination Connectors`. To explore the complete list and usage, please refer to [Destination Connectors documentation](/ingestion/destination-connectors/overview). Note: We are constantly expanding our collection of destination connectors. If you wish to request a specific Destination Connector, you’re encouraged to submit a Feature Request on the [Unstructured GitHub repository](https://github.com/Unstructured-IO/unstructured/issues/new/choose). diff --git a/open-source/introduction/overview.mdx b/open-source/introduction/overview.mdx index 295dbaaa..84da4a7f 100644 --- a/open-source/introduction/overview.mdx +++ b/open-source/introduction/overview.mdx @@ -30,7 +30,7 @@ and use cases. * [Chunking](/open-source/core-functionality/chunking): The chunking process in Unstructured is distinct from conventional methods. Instead of relying solely on text-based features to form chunks, Unstructured uses a deep understanding of document formats to partition documents into semantic units (document elements). -* **High-performant Connectors**: The platform includes optimized connectors for efficient data ingestion and output. These comprise [Source Connectors](../ingest/source-connectors/overview) for data input and [Destination Connectors](../ingest/destination-connectors/overview) for data export. +* **High-performant Connectors**: The platform includes optimized connectors for efficient data ingestion and output. These comprise [Source Connectors](/ingestion/source-connectors/overview) for data input and [Destination Connectors](/ingestion/destination-connectors/overview) for data export. ## Common use cases diff --git a/platform-api/api/destinations/astradb.mdx b/platform-api/api/destinations/astradb.mdx index 3b5c6f5e..edaff651 100644 --- a/platform-api/api/destinations/astradb.mdx +++ b/platform-api/api/destinations/astradb.mdx @@ -29,4 +29,4 @@ import AstraDBAPIPlaceholders from '/snippets/general-shared-text/astradb-api-pl To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/azure-ai-search.mdx b/platform-api/api/destinations/azure-ai-search.mdx index ab8ceefa..ccf52b19 100644 --- a/platform-api/api/destinations/azure-ai-search.mdx +++ b/platform-api/api/destinations/azure-ai-search.mdx @@ -29,4 +29,4 @@ import AzureAIAPIPlaceholders from '/snippets/general-shared-text/azure-ai-searc To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/couchbase.mdx b/platform-api/api/destinations/couchbase.mdx index 2efba48f..36c63d4a 100644 --- a/platform-api/api/destinations/couchbase.mdx +++ b/platform-api/api/destinations/couchbase.mdx @@ -29,4 +29,4 @@ import CouchbaseAPIPlaceholders from '/snippets/general-shared-text/couchbase-ap To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/databricks-delta-table.mdx b/platform-api/api/destinations/databricks-delta-table.mdx index 090611a7..9763237c 100644 --- a/platform-api/api/destinations/databricks-delta-table.mdx +++ b/platform-api/api/destinations/databricks-delta-table.mdx @@ -6,10 +6,10 @@ title: Delta Tables in Databricks This article covers connecting Unstructured to Delta Tables in Databricks. For information about connecting Unstructured to Delta Tables in Amazon S3 instead, see - [Delta Tables in Amazon S3](/platform/api/destinations/delta-table). + [Delta Tables in Amazon S3](/platform-api/api/destinations/delta-table). For information about connecting Unstructured to Databricks Volumes instead, see - [Databricks Volumes](/platform/api/destinations/databricks-volumes). + [Databricks Volumes](/platform-api/api/destinations/databricks-volumes). Send processed data from Unstructured to a Delta Table in Databricks. @@ -39,4 +39,4 @@ import DeltaTablesInDatabricksAPIPlaceholders from '/snippets/general-shared-tex To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/databricks-volumes.mdx b/platform-api/api/destinations/databricks-volumes.mdx index 8dbfcb99..2b5a1e94 100644 --- a/platform-api/api/destinations/databricks-volumes.mdx +++ b/platform-api/api/destinations/databricks-volumes.mdx @@ -6,7 +6,7 @@ title: Databricks Volumes This article covers connecting Unstructured to Databricks Volumes. For information about connecting Unstructured to Delta Tables in Databricks instead, see - [Delta Tables in Databricks](/platform/api/destinations/databricks-delta-table). + [Delta Tables in Databricks](/platform-api/api/destinations/databricks-delta-table). Send processed data from Unstructured to Databricks Volumes. @@ -36,4 +36,4 @@ import DatabricksVolumesAPIPlaceholders from '/snippets/general-shared-text/data To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/delta-table.mdx b/platform-api/api/destinations/delta-table.mdx index 9818237d..b83e24fe 100644 --- a/platform-api/api/destinations/delta-table.mdx +++ b/platform-api/api/destinations/delta-table.mdx @@ -5,7 +5,7 @@ title: Delta Tables in Amazon S3 This article covers connecting Unstructured to Delta Tables in Amazon S3. For information about connecting Unstructured to Delta Tables in Databricks instead, see - [Delta Tables in Databricks](/platform/api/destinations/databricks-delta-table). + [Delta Tables in Databricks](/platform-api/api/destinations/databricks-delta-table). Send processed data from Unstructured to a Delta Table, stored in Amazon S3. @@ -35,4 +35,4 @@ import DeltaTableAPIPlaceholders from '/snippets/general-shared-text/delta-table To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/elasticsearch.mdx b/platform-api/api/destinations/elasticsearch.mdx index 10d998cf..f01b0658 100644 --- a/platform-api/api/destinations/elasticsearch.mdx +++ b/platform-api/api/destinations/elasticsearch.mdx @@ -29,4 +29,4 @@ import ElasticsearchAPIPlaceholders from '/snippets/general-shared-text/elastics To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/google-cloud.mdx b/platform-api/api/destinations/google-cloud.mdx index 018b45c1..b607a5f1 100644 --- a/platform-api/api/destinations/google-cloud.mdx +++ b/platform-api/api/destinations/google-cloud.mdx @@ -29,4 +29,4 @@ import GCSAPIPlaceholders from '/snippets/general-shared-text/gcs-api-placeholde To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/kafka.mdx b/platform-api/api/destinations/kafka.mdx index c2688b56..80121eef 100644 --- a/platform-api/api/destinations/kafka.mdx +++ b/platform-api/api/destinations/kafka.mdx @@ -29,4 +29,4 @@ import KafkaAPIPlaceholders from '/snippets/general-shared-text/kafka-api-placeh To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/milvus.mdx b/platform-api/api/destinations/milvus.mdx index a6c5ac7b..3610fc9a 100644 --- a/platform-api/api/destinations/milvus.mdx +++ b/platform-api/api/destinations/milvus.mdx @@ -29,4 +29,4 @@ import MilvusAPIPlaceholders from '/snippets/general-shared-text/milvus-api-plac To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/mongodb.mdx b/platform-api/api/destinations/mongodb.mdx index 89679ff2..8a83d2be 100644 --- a/platform-api/api/destinations/mongodb.mdx +++ b/platform-api/api/destinations/mongodb.mdx @@ -29,4 +29,4 @@ import MongoDBAPIPlaceholders from '/snippets/general-shared-text/mongodb-api-pl To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/motherduck.mdx b/platform-api/api/destinations/motherduck.mdx index 37078793..4c637327 100644 --- a/platform-api/api/destinations/motherduck.mdx +++ b/platform-api/api/destinations/motherduck.mdx @@ -27,4 +27,4 @@ import MotherDuckAPIPlaceholders from '/snippets/general-shared-text/motherduck- To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/neo4j.mdx b/platform-api/api/destinations/neo4j.mdx index 1bb712d4..2ab56305 100644 --- a/platform-api/api/destinations/neo4j.mdx +++ b/platform-api/api/destinations/neo4j.mdx @@ -35,4 +35,4 @@ import Neo4jAPIPlaceholders from '/snippets/general-shared-text/neo4j-api-placeh To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/onedrive.mdx b/platform-api/api/destinations/onedrive.mdx index d8ca6fe5..699e472d 100644 --- a/platform-api/api/destinations/onedrive.mdx +++ b/platform-api/api/destinations/onedrive.mdx @@ -29,4 +29,4 @@ import OneDriveAPIPlaceholders from '/snippets/general-shared-text/onedrive-api- To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/overview.mdx b/platform-api/api/destinations/overview.mdx index 7d419aa7..6665ff7d 100644 --- a/platform-api/api/destinations/overview.mdx +++ b/platform-api/api/destinations/overview.mdx @@ -2,41 +2,41 @@ title: Overview --- -To use the [Unstructured Platform Workflow Endpoint](/platform/api/overview) to manage destination connectors, do the following: +To use the [Unstructured Platform Workflow Endpoint](/platform-api/api/overview) to manage destination connectors, do the following: - To get a list of available destination connectors, use the `UnstructuredClient` object's `destinations.list_destinations` function (for the Python SDK) or - the `GET` method to call the `/destinations` endpoint (for `curl` or Postman).. [Learn more](/platform/api/overview#list-destination-connectors). + the `GET` method to call the `/destinations` endpoint (for `curl` or Postman).. [Learn more](/platform-api/api/overview#list-destination-connectors). - To get information about a destination connector, use the `UnstructuredClient` object's `destinations.get_destination` function (for the Python SDK) or - the `GET` method to call the `/destinations/` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#get-a-destination-connector). + the `GET` method to call the `/destinations/` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#get-a-destination-connector). - To create a destination connector, use the `UnstructuredClient` object's `destinations.create_destination` function (for the Python SDK) or - the `POST` method to call the `/destinations` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#create-a-destination-connector). + the `POST` method to call the `/destinations` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#create-a-destination-connector). - To update a destination connector, use the `UnstructuredClient` object's `destinations.update_destination` function (for the Python SDK) or - the `PUT` method to call the `/destinations/` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#update-a-destination-connector). + the `PUT` method to call the `/destinations/` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#update-a-destination-connector). - To delete a destination connector, use the `UnstructuredClient` object's `destinations.delete_destination` function (for the Python SDK) or - the `DELETE` method to call the `/destinations/` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#delete-a-destination-connector). + the `DELETE` method to call the `/destinations/` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#delete-a-destination-connector). To create or update a destination connector, you must also provide settings that are specific to that connector. For the list of specific settings, see: -- [Astra DB](/platform/api/destinations/astradb) (`astradb`) -- [Azure AI Search](/platform/api/destinations/azure-ai-search) (`azure_ai_search`) -- [Couchbase](/platform/api/destinations/couchbase) (`couchbase`) -- [Databricks Volumes](/platform/api/destinations/databricks-volumes) (`databricks_volumes`) -- [Delta Tables in Amazon S3](/platform/api/destinations/delta-table) (`delta_table`) -- [Delta Tables in Databricks](/platform/api/destinations/databricks-delta-table) (`databricks_volume_delta_tables`) -- [Elasticsearch](/platform/api/destinations/elasticsearch) (`elasticsearch`) -- [Google Cloud Storage](/platform/api/destinations/google-cloud) (`gcs`) -- [Kafka](/platform/api/destinations/kafka) (`kafka-cloud`) -- [Milvus](/platform/api/destinations/milvus) (`milvus`) -- [MongoDB](/platform/api/destinations/mongodb) (`mongodb`) -- [MotherDuck](/platform/api/destinations/motherduck) (`motherduck`) -- [Neo4j](/platform/api/destinations/neo4j) (`neo4j`) -- [OneDrive](/platform/api/destinations/onedrive) (`onedrive`) -- [Pinecone](/platform/api/destinations/pinecone) (`pinecone`) -- [PostgreSQL](/platform/api/destinations/postgresql) (`postgres`) -- [Qdrant](/platform/api/destinations/qdrant) (`qdrant-cloud`) -- [Redis](/platform/api/destinations/redis) (`redis`) -- [Snowflake](/platform/api/destinations/snowflake) (`snowflake`) -- [S3](/platform/api/destinations/s3) (`s3`) -- [Weaviate](/platform/api/destinations/weaviate) (`weaviate`) +- [Astra DB](/platform-api/api/destinations/astradb) (`astradb`) +- [Azure AI Search](/platform-api/api/destinations/azure-ai-search) (`azure_ai_search`) +- [Couchbase](/platform-api/api/destinations/couchbase) (`couchbase`) +- [Databricks Volumes](/platform-api/api/destinations/databricks-volumes) (`databricks_volumes`) +- [Delta Tables in Amazon S3](/platform-api/api/destinations/delta-table) (`delta_table`) +- [Delta Tables in Databricks](/platform-api/api/destinations/databricks-delta-table) (`databricks_volume_delta_tables`) +- [Elasticsearch](/platform-api/api/destinations/elasticsearch) (`elasticsearch`) +- [Google Cloud Storage](/platform-api/api/destinations/google-cloud) (`gcs`) +- [Kafka](/platform-api/api/destinations/kafka) (`kafka-cloud`) +- [Milvus](/platform-api/api/destinations/milvus) (`milvus`) +- [MongoDB](/platform-api/api/destinations/mongodb) (`mongodb`) +- [MotherDuck](/platform-api/api/destinations/motherduck) (`motherduck`) +- [Neo4j](/platform-api/api/destinations/neo4j) (`neo4j`) +- [OneDrive](/platform-api/api/destinations/onedrive) (`onedrive`) +- [Pinecone](/platform-api/api/destinations/pinecone) (`pinecone`) +- [PostgreSQL](/platform-api/api/destinations/postgresql) (`postgres`) +- [Qdrant](/platform-api/api/destinations/qdrant) (`qdrant-cloud`) +- [Redis](/platform-api/api/destinations/redis) (`redis`) +- [Snowflake](/platform-api/api/destinations/snowflake) (`snowflake`) +- [S3](/platform-api/api/destinations/s3) (`s3`) +- [Weaviate](/platform-api/api/destinations/weaviate) (`weaviate`) diff --git a/platform-api/api/destinations/pinecone.mdx b/platform-api/api/destinations/pinecone.mdx index 95860229..f2e6d86a 100644 --- a/platform-api/api/destinations/pinecone.mdx +++ b/platform-api/api/destinations/pinecone.mdx @@ -29,4 +29,4 @@ import PineconeAPIPlaceholders from '/snippets/general-shared-text/pinecone-api- To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/postgresql.mdx b/platform-api/api/destinations/postgresql.mdx index 280bb42d..ab1681b7 100644 --- a/platform-api/api/destinations/postgresql.mdx +++ b/platform-api/api/destinations/postgresql.mdx @@ -29,4 +29,4 @@ import PostgreSQLAPIPlaceholders from '/snippets/general-shared-text/postgresql- To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/qdrant.mdx b/platform-api/api/destinations/qdrant.mdx index 3b54773b..a8d9a233 100644 --- a/platform-api/api/destinations/qdrant.mdx +++ b/platform-api/api/destinations/qdrant.mdx @@ -29,4 +29,4 @@ import QdrantAPIPlaceholders from '/snippets/general-shared-text/qdrant-api-plac To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/redis.mdx b/platform-api/api/destinations/redis.mdx index 941d0dbc..8d4f1a53 100644 --- a/platform-api/api/destinations/redis.mdx +++ b/platform-api/api/destinations/redis.mdx @@ -29,4 +29,4 @@ import RedisAPIPlaceholders from '/snippets/general-shared-text/redis-api-placeh To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/s3.mdx b/platform-api/api/destinations/s3.mdx index 928fdbe9..bdc15928 100644 --- a/platform-api/api/destinations/s3.mdx +++ b/platform-api/api/destinations/s3.mdx @@ -29,4 +29,4 @@ import s3APIPlaceholders from '/snippets/general-shared-text/s3-api-placeholders To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/snowflake.mdx b/platform-api/api/destinations/snowflake.mdx index 5161cbc0..09b0116e 100644 --- a/platform-api/api/destinations/snowflake.mdx +++ b/platform-api/api/destinations/snowflake.mdx @@ -29,4 +29,4 @@ import SnowflakeAPIPlaceholders from '/snippets/general-shared-text/snowflake-ap To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/destinations/weaviate.mdx b/platform-api/api/destinations/weaviate.mdx index a0bf722c..da7aa74f 100644 --- a/platform-api/api/destinations/weaviate.mdx +++ b/platform-api/api/destinations/weaviate.mdx @@ -29,4 +29,4 @@ import WeaviateAPIPlaceholders from '/snippets/general-shared-text/weaviate-api- To change a connector, replace `` with the destination connector's unique ID. -To get this ID, see [List destination connectors](/platform/api/overview#list-destination-connectors). \ No newline at end of file +To get this ID, see [List destination connectors](/platform-api/api/overview#list-destination-connectors). \ No newline at end of file diff --git a/platform-api/api/jobs.mdx b/platform-api/api/jobs.mdx index f5de183c..2e065d14 100644 --- a/platform-api/api/jobs.mdx +++ b/platform-api/api/jobs.mdx @@ -2,13 +2,13 @@ title: Jobs --- -To use the [Unstructured Platform Workflow Endpoint](/platform/api/overview) to manage jobs, do the following: +To use the [Unstructured Platform Workflow Endpoint](/platform-api/api/overview) to manage jobs, do the following: - To get a list of available jobs, use the `UnstructuredClient` object's `jobs.list_jobs` function (for the Python SDK) or - the `GET` method to call the `/jobs` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#list-jobs). + the `GET` method to call the `/jobs` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#list-jobs). - To get information about a job, use the `UnstructuredClient` object's `jobs.get_job` function (for the Python SDK) or - the `GET` method to call the `/jobs/` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#get-a-job). -- A job is created automatically whenever a workflow runs on a schedule; see [Create a workflow](/platform/api/workflows#create-a-workflow). - A job is also created whenever you run a workflow manually; see [Run a workflow](/platform/api/overview#run-a-workflow). + the `GET` method to call the `/jobs/` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#get-a-job). +- A job is created automatically whenever a workflow runs on a schedule; see [Create a workflow](/platform-api/api/workflows#create-a-workflow). + A job is also created whenever you run a workflow manually; see [Run a workflow](/platform-api/api/overview#run-a-workflow). - To cancel a running job, use the `UnstructuredClient` object's `jobs.cancel_job` function (for the Python SDK) or - the `POST` method to call the `/jobs//cancel` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#cancel-a-job). \ No newline at end of file + the `POST` method to call the `/jobs//cancel` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#cancel-a-job). \ No newline at end of file diff --git a/platform-api/api/overview.mdx b/platform-api/api/overview.mdx index d4edf11c..52a0852c 100644 --- a/platform-api/api/overview.mdx +++ b/platform-api/api/overview.mdx @@ -11,7 +11,15 @@ various storage, databases, and vector stores; and use the latest and highest-pe to deliver the highest quality results at the lowest cost. This page provides an overview of the Unstructured Platform Workflow Endpoint. This endpoint enables Unstructured Platform UI automation usage -scenarios as well as for documentation, reporting, and recovery needs. +scenarios as well as for documentation, reporting, and recovery needs. + +## Getting started + +Choose one of the following options to get started with the Unstructured Platform Workflow Endpoint: + +- Follow the [quickstart](#quickstart), which uses the Unstructured Python SDK from a remote hosted Google Collab notebook. +- Start using the [Unstructred Python SDK](#unstructured-python-sdk). +- Start using a [REST](#rest-endpoints) client, such as `curl` or Postman. ## Quickstart @@ -36,46 +44,35 @@ If you already have the Unstructured Python SDK installed, upgrade to at least v pip install --upgrade "unstructured-client>=0.30.6" ``` -## REST endpoints +The Unstructured Python SDK code examples, shown later on this page and on related pages, use the following environment variable, which you can set as follows: -The Unstructured Platform Workflow Endpoint is also callable from a set of Representational State Transfer (REST) endpoints, which you can call through standard REST-enabled -utilities, tools, programming languages, packages, and libraries. The following sections describe how to call the Unstructured Platform Workflow Endpoint with -`curl` and Postman. You can adapt this information as needed for your preferred programming languages and libraries, for example by using the -`requests` library with Python. +```bash +export UNSTRUCTURED_API_KEY="" +``` - - You can also use the [Unstructured Platform Workflow Endpoint - Swagger UI](https://platform.unstructuredapp.io/docs) to call the REST endpoints - that are available through `https://platform.unstructuredapp.io`. - +This environment variable enables you to more easily run the following Unstructured Python SDK examples and help prevent +you from storing scripts that contain sensitive API keys in public source code repositories. -To call the REST endpoints, you must specify the Unstructured **Platform API URL**. This is typically `https://platform.unstructuredapp.io/api/v1`. +To get your Unstructured API key, do the following: -![Unstructured Platform API URL](/img/platform/PlatformAPIURL.png) +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). +2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. +3. On the **API Keys** tab, click **Generate New Key**. +4. Enter some descriptive name for the API key, and then click **Save**. +5. Click the **Copy** icon for your new API key. The API key's value is copied to your system's clipboard. - - Do not use the Unstructured **Serverless API URL**, which is separate from the Unstructured Platform Workflow Endpoint URL. - +Calls made by the Unstructured Python SDK's `unstructured_client` functions for creating, listing, updating, +and deleting connectors, workflows, and jobs in the Unstructured Platform UI all use the Unstructured Platform Workflow Endpoint URL (`https://platform.unstructuredapp.io/api/v1`) by default. You do not need to +use the `server_url` parameter to specify this API URL in your Python code for these particular functions. - If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL - might be different. For API URL guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL and API key creation guidance + might be different. For guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). If your API URL is different, be sure to substitute `https://platform.unstructuredapp.io/api/v1` for your API URL throughout the following examples. - - -## Restrictions -The following Unstructured SDKs, tools, and libraries do _not_ work with the Unstructured Platform Workflow Endpoint: - -- The [Unstructured JavaScript/TypeScript SDK](/platform-api/partition-api/sdk-jsts) -- [Local single-file POST requests](/platform-api/partition-api/sdk-jsts) to the Unstructured Platform Partition Endpoint -- The [Unstructured open source Python library](/open-source/introducton/overview) -- The [Unstructued Ingest CLI](/ingestion/ingest-cli) -- The [Unstructured Ingest Python library](/ingestion/python-ingest) - -The following Unstructured API URL is also _not_ supported: `https://api.unstructuredapp.io/general/v0/general` (the Unstructured Platform Partition Endpoint URL). - -## Basics + To specify an API URL in your code, set the `server_url` parameter in the `UnstructuredClient` constructor to the target API URL. + The Unstructured Platform Workflow Endpoint enables you to work with [connectors](#connectors), [workflows](#workflows), and [jobs](#jobs) in the Unstructured Platform UI. @@ -91,47 +88,50 @@ For general information about these objects, see: - [Workflows](/platform/workflows) - [Jobs](/platform/jobs) -The following sections provide examples, showing the use of the Unstructured SDK for Python for all of the supported API operations, -as well as `curl` and Postman for all of the supported REST endpoints. +Skip ahead to start learning about how to use the Unstructured Python SDK to work with +[connectors](#connectors), +[workflows](#workflows), and [jobs](#jobs) programmatically. + +## REST endpoints + +The Unstructured Platform Workflow Endpoint is callable from a set of Representational State Transfer (REST) endpoints, which you can call through standard REST-enabled +utilities, tools, programming languages, packages, and libraries. The examples, shown later on this page and on related pages, describe how to call the Unstructured Platform Workflow Endpoint with +`curl` and Postman. You can adapt this information as needed for your preferred programming languages and libraries, for example by using the +`requests` library with Python. You can also use the [Unstructured Platform Workflow Endpoint - Swagger UI](https://platform.unstructuredapp.io/docs) to call the REST endpoints - that are available through `https://platform.unstructuredapp.io`. + that are available through `https://platform.unstructuredapp.io`. To use the Swagger UI, you must provide your Unstructured API key with each call. To + get this API key, see the [quickstart](#quickstart), earlier on this page. -### Python SDK +### curl and Postman -The following Unstructured Python SDK examples use the following environment variable, which you can set as follows: +The following `curl` examples use the following environment variables, which you can set as follows: ```bash +export UNSTRUCTURED_API_URL="https://platform.unstructuredapp.io/api/v1" export UNSTRUCTURED_API_KEY="" ``` -Calls made by the Unstructured Python SDK's `unstructured_client` functions for creating, listing, updating, -and deleting connectors, workflows, and jobs in the Unstructured Platform UI all use the Unstrucutured Platform Workflow Endpoint URL (`https://platform.unstructuredapp.io/api/v1`) by default. You do not need to -use the `server_url` parameter to specify this API URL in your Python code for these particular functions. +These environment variables enable you to more easily run the following `curl` examples and help prevent +you from storing scripts that contain sensitive URLs and API keys in public source code repositories. + +To get your Unstructured API key, do the following: + +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). +2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. +3. On the **API Keys** tab, click **Generate New Key**. +4. Enter some descriptive name for the API key, and then click **Save**. +5. Click the **Copy** icon for your new API key. The API key's value is copied to your system's clipboard. - If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL - might be different. For API URL guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL and API key creation guidance + might be different. For guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). If your API URL is different, be sure to substitute `https://platform.unstructuredapp.io/api/v1` for your API URL throughout the following examples. - - To specify an API URL in your code, set the `server_url` parameter in the `UnstructuredClient` constructor to the target API URL. -### curl and Postman - -The following `curl` and Postman examples use the following environment variables, which you can set as follows: - -```bash -export UNSTRUCTURED_API_URL="https://platform.unstructuredapp.io/api/v1" -export UNSTRUCTURED_API_KEY="" -``` - -These environment variables enable you to more easily run the following Unstructured Python SDK and `curl` examples and help prevent -you from storing scripts that contain sensitive URLs and API keys in public source code repositories. - The following Postman examples use variables, which you can set as follows: 1. In Postman, on your workspace's sidebar, click **Environments**. @@ -143,7 +143,7 @@ The following Postman examples use variables, which you can set as follows: - **Initial value**: `https://platform.unstructuredapp.io/api/v1` - **Current value**: `https://platform.unstructuredapp.io/api/v1`
- - **Variable**: `UNSTRUCTURED_API_URL` + - **Variable**: `UNSTRUCTURED_API_KEY` - **Type**: `secret` - **Initial value**: `` - **Current value**: `` @@ -153,6 +153,51 @@ The following Postman examples use variables, which you can set as follows: These variables enable you to more easily run the following examples in Postman and help prevent you from storing Postman collections that contain sensitive URLs and API keys in public source code repositories. +To get your Unstructured API key, do the following: + +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). +2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. +3. On the **API Keys** tab, click **Generate New Key**. +4. Enter some descriptive name for the API key, and then click **Save**. +5. Click the **Copy** icon for your new API key. The API key's value is copied to your system's clipboard. + + + If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, your API URL and API key creation guidance + might be different. For guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + If your API URL is different, be sure to substitute `https://platform.unstructuredapp.io/api/v1` for your + API URL throughout the following examples. + + +The Unstructured Platform Workflow Endpoint enables you to work with [connectors](#connectors), +[workflows](#workflows), and [jobs](#jobs) in the Unstructured Platform UI. + +- A _source connector_ ingests files or data into Unstructured from a source location. +- A _destination connector_ sends the processed data from Unstructured to a destination location. +- A _workflow_ defines how Unstructured will process the data. +- A _job_ runs a workflow at a specific point in time. + +For general information about these objects, see: + +- [Connectors](/platform/connectors) +- [Workflows](/platform/workflows) +- [Jobs](/platform/jobs) + +Skip ahead to start learning about how to use the REST endpoints to work with +[connectors](#connectors), +[workflows](#workflows), and [jobs](#jobs) programmatically. + +## Restrictions + +The following Unstructured SDKs, tools, and libraries do _not_ work with the Unstructured Platform Workflow Endpoint: + +- The [Unstructured JavaScript/TypeScript SDK](/platform-api/partition-api/sdk-jsts) +- [Local single-file POST requests](/platform-api/partition-api/sdk-jsts) to the Unstructured Platform Partition Endpoint +- The [Unstructured open source Python library](/open-source/introduction/overview) +- The [Unstructued Ingest CLI](/ingestion/ingest-cli) +- The [Unstructured Ingest Python library](/ingestion/python-ingest) + +The following Unstructured API URL is also _not_ supported: `https://api.unstructuredapp.io/general/v0/general` (the Unstructured Platform Partition Endpoint URL). + ## Connectors You can [list](#list-source-connectors), @@ -177,7 +222,7 @@ To filter the list of source connectors, use the `ListSourcesRequest` object's ` or the query parameter `source_type=` (for `curl` or Postman), replacing `` with the source connector type's unique ID (for example, `s3` for the Amazon S3 source connector type). -To get this ID, see [Sources](/platform/api/sources/overview). +To get this ID, see [Sources](/platform-api/api/sources/overview). @@ -311,7 +356,7 @@ the `POST` method to call the `/sources` endpoint (for `curl` or Postman). In the `CreateSourceConnector` object (for the Python SDK) or the request body (for `curl` or Postman), specify the settings for the connector. For the specific settings to include, which differ by connector, see -[Sources](/platform/api/sources/overview). +[Sources](/platform-api/api/sources/overview). @@ -390,7 +435,7 @@ the `PUT` method to call the `/sources/` endpoint (for `curl` or P In the `UpdateSourceConnector` object (for the Python SDK) or the request body (for `curl` or Postman), specify the settings for the connector. For the specific settings to include, which differ by connector, see -[Sources](/platform/api/sources/overview). +[Sources](/platform-api/api/sources/overview). You must specify all of the settings for the connector, even for settings that are not changing. @@ -525,7 +570,7 @@ To filter the list of destination connectors, use the `ListDestinationsRequest` the query parameter `destination_type=` (for `curl` or Postman), replacing `` with the destination connector type's unique ID (for example, `s3` for the Amazon S3 destination connector type). -To get this ID, see [Destinations](/platform/api/destinations/overview). +To get this ID, see [Destinations](/platform-api/api/destinations/overview). @@ -658,7 +703,7 @@ the `POST` method to call the `/destinations` endpoint (for `curl` or Postman). In the `CreateDestinationConnector` object (for the Python SDK) or the request body (for `curl` or Postman), specify the settings for the connector. For the specific settings to include, which differ by connector, see -[Destinations](/platform/api/destinations/overview). +[Destinations](/platform-api/api/destinations/overview). @@ -736,7 +781,7 @@ the `PUT` method to call the `/destinations/` endpoint (for `curl` In the `UpdateDestinationConnector` object (for the Python SDK) or the request body (for `curl` or Postman), specify the settings for the connector. For the specific settings to include, which differ by connector, see -[Destinations](/platform/api/destinations/overview). +[Destinations](/platform-api/api/destinations/overview). You must specify all of the settings for the connector, even for settings that are not changing. @@ -1055,7 +1100,7 @@ the `POST` method to call the `/workflows` endpoint (for `curl` or Postman). In the `CreateWorkflow` object (for the Python SDK) or the request body (for `curl` or Postman), specify the settings for the workflow. For the specific settings to include, see -[Create a workflow](/platform/api/workflows#create-a-workflow). +[Create a workflow](/platform-api/api/workflows#create-a-workflow). @@ -1187,7 +1232,7 @@ the `POST` method to call the `/workflows//run` endpoint (for `curl To run a workflow on a schedule instead, specify the `schedule` setting in the request body when you create or update a -workflow. See [Create a workflow](/platform/api/workflows#create-a-workflow) or [Update a workflow](/platform/api/workflows#update-a-workflow). +workflow. See [Create a workflow](/platform-api/api/workflows#create-a-workflow) or [Update a workflow](/platform-api/api/workflows#update-a-workflow). ### Update a workflow @@ -1197,7 +1242,7 @@ the `PUT` method to call the `/workflows/` endpoint (for `curl` or In `UpdateWorkflow` object (for the Python SDK) or the request body (for `curl` or Postman), specify the settings for the workflow. For the specific settings to include, see -[Update a workflow](/platform/api/workflows#update-a-workflow). +[Update a workflow](/platform-api/api/workflows#update-a-workflow). diff --git a/platform-api/api/sources/azure-blob-storage.mdx b/platform-api/api/sources/azure-blob-storage.mdx index 38920987..221b720c 100644 --- a/platform-api/api/sources/azure-blob-storage.mdx +++ b/platform-api/api/sources/azure-blob-storage.mdx @@ -29,4 +29,4 @@ import AzureAPIPlaceholders from '/snippets/general-shared-text/azure-api-placeh To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/box.mdx b/platform-api/api/sources/box.mdx index 23cc8b4a..3366244e 100644 --- a/platform-api/api/sources/box.mdx +++ b/platform-api/api/sources/box.mdx @@ -29,4 +29,4 @@ import BoxAPIPlaceholders from '/snippets/general-shared-text/box-api-placeholde To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/confluence.mdx b/platform-api/api/sources/confluence.mdx index 4c29ab56..8dfda15b 100644 --- a/platform-api/api/sources/confluence.mdx +++ b/platform-api/api/sources/confluence.mdx @@ -29,4 +29,4 @@ import ConfluenceAPIPlaceholders from '/snippets/general-shared-text/confluence- To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/couchbase.mdx b/platform-api/api/sources/couchbase.mdx index 41a16b1d..93ae84e3 100644 --- a/platform-api/api/sources/couchbase.mdx +++ b/platform-api/api/sources/couchbase.mdx @@ -29,4 +29,4 @@ import CouchbaseAPIPlaceholders from '/snippets/general-shared-text/couchbase-ap To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/databricks-volumes.mdx b/platform-api/api/sources/databricks-volumes.mdx index 0e16f4dc..81f18509 100644 --- a/platform-api/api/sources/databricks-volumes.mdx +++ b/platform-api/api/sources/databricks-volumes.mdx @@ -29,4 +29,4 @@ import DatabricksVolumesAPIPlaceholders from '/snippets/general-shared-text/data To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/dropbox.mdx b/platform-api/api/sources/dropbox.mdx index 2d768dd9..d83ac284 100644 --- a/platform-api/api/sources/dropbox.mdx +++ b/platform-api/api/sources/dropbox.mdx @@ -29,4 +29,4 @@ import DropboxAPIPlaceholders from '/snippets/general-shared-text/dropbox-api-pl To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/elasticsearch.mdx b/platform-api/api/sources/elasticsearch.mdx index d4b49712..9b0135a0 100644 --- a/platform-api/api/sources/elasticsearch.mdx +++ b/platform-api/api/sources/elasticsearch.mdx @@ -29,4 +29,4 @@ import ElasticsearchAPIPlaceholders from '/snippets/general-shared-text/elastics To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/google-cloud.mdx b/platform-api/api/sources/google-cloud.mdx index 9cfc561e..3e2899e0 100644 --- a/platform-api/api/sources/google-cloud.mdx +++ b/platform-api/api/sources/google-cloud.mdx @@ -29,4 +29,4 @@ import GCSAPIPlaceholders from '/snippets/general-shared-text/gcs-api-placeholde To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/google-drive.mdx b/platform-api/api/sources/google-drive.mdx index 73c4d0ec..32def3fb 100644 --- a/platform-api/api/sources/google-drive.mdx +++ b/platform-api/api/sources/google-drive.mdx @@ -29,4 +29,4 @@ import GoogleDriveAPIPlaceholders from '/snippets/general-shared-text/google-dri To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/kafka.mdx b/platform-api/api/sources/kafka.mdx index 9892047f..fb2c201c 100644 --- a/platform-api/api/sources/kafka.mdx +++ b/platform-api/api/sources/kafka.mdx @@ -29,4 +29,4 @@ import KafkaAPIPlaceholders from '/snippets/general-shared-text/kafka-api-placeh To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/mongodb.mdx b/platform-api/api/sources/mongodb.mdx index 10af6aca..9f182ff5 100644 --- a/platform-api/api/sources/mongodb.mdx +++ b/platform-api/api/sources/mongodb.mdx @@ -29,4 +29,4 @@ import MongoDBAPIPlaceholders from '/snippets/general-shared-text/mongodb-api-pl To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/onedrive.mdx b/platform-api/api/sources/onedrive.mdx index d938db8b..7a3d9389 100644 --- a/platform-api/api/sources/onedrive.mdx +++ b/platform-api/api/sources/onedrive.mdx @@ -29,4 +29,4 @@ import OneDriveAPIPlaceholders from '/snippets/general-shared-text/onedrive-api- To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/outlook.mdx b/platform-api/api/sources/outlook.mdx index 2a9d8fbe..1f2d55ca 100644 --- a/platform-api/api/sources/outlook.mdx +++ b/platform-api/api/sources/outlook.mdx @@ -29,4 +29,4 @@ import OutlookAPIPlaceholders from '/snippets/general-shared-text/outlook-api-pl To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/overview.mdx b/platform-api/api/sources/overview.mdx index 4f6565d0..e4f1cc01 100644 --- a/platform-api/api/sources/overview.mdx +++ b/platform-api/api/sources/overview.mdx @@ -2,38 +2,39 @@ title: Overview --- -To use the [Unstructured Platform Workflow Endpoint](/platform/api/overview) to manage source connectors, do the following: +To use the [Unstructured Platform Workflow Endpoint](/platform-api/api/overview) to manage source connectors, do the following: - To get a list of available source connectors, use the `UnstructuredClient` object's `sources.list_sources` function (for the Python SDK) or - the `GET` method to call the `/sources` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#list-source-connectors). + the `GET` method to call the `/sources` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#list-source-connectors). - To get information about a source connector, use the `UnstructuredClient` object's `sources.get_source` function (for the Python SDK) or - the `GET` method to call the `/sources/` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#get-a-source-connector). + the `GET` method to call the `/sources/` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#get-a-source-connector). - To create a source connector, use the `UnstructuredClient` object's `sources.create_source` function (for the Python SDK) or - the `POST` method to call the `/sources` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#create-a-source-connector). + the `POST` method to call the `/sources` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#create-a-source-connector). - To update a source connector, use the `UnstructuredClient` object's `sources.update_source` function (for the Python SDK) or - the `PUT` method to call the `/sources/` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#update-a-source-connector). + the `PUT` method to call the `/sources/` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#update-a-source-connector). - To delete a source connector, use the `UnstructuredClient` object's `sources.delete_source` function (for the Python SDK) or - the `DELETE` method to call the `/sources/` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#delete-a-source-connector). + the `DELETE` method to call the `/sources/` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#delete-a-source-connector). To create or update a source connector, you must also provide settings that are specific to that connector. For the list of specific settings, see: -- [Azure](/platform/api/sources/azure-blob-storage) (`azure`) -- [Box](/platform/api/sources/box) (`box`) -- [Confluence](/platform/api/sources/confluence) (`confluence`) -- [Couchbase](/platform/api/sources/couchbase) (`couchbase`) -- [Databricks Volumes](/platform/api/sources/databricks-volumes) (`databricks_volumes`) -- [Dropbox](/platform/api/sources/dropbox) (`dropbox`) -- [Elasticsearch](/platform/api/sources/elasticsearch) (`elasticsearch`) -- [Google Cloud Storage](/platform/api/sources/google-cloud) (`gcs`) -- [Google Drive](/platform/api/sources/google-drive) (`google_drive`) -- [Kafka](/platform/api/sources/kafka) (`kafka-cloud`) -- [MongoDB](/platform/api/sources/mongodb) (`mongodb`) -- [OneDrive](/platform/api/sources/onedrive) (`onedrive`) -- [Outlook](/platform/api/sources/outlook) (`outlook`) -- [PostgreSQL](/platform/api/sources/postgresql) (`postgres`) -- [S3](/platform/api/sources/s3) (`s3`) -- [Salesforce](/platform/api/sources/salesforce) (`salesforce`) -- [SharePoint](/platform/api/sources/sharepoint) (`sharepoint`) -- [Snowflake](/platform/api/sources/snowflake) (`snowflake`) +- [Azure](/platform-api/api/sources/azure-blob-storage) (`azure`) +- [Box](/platform-api/api/sources/box) (`box`) +- [Confluence](/platform-api/api/sources/confluence) (`confluence`) +- [Couchbase](/platform-api/api/sources/couchbase) (`couchbase`) +- [Databricks Volumes](/platform-api/api/sources/databricks-volumes) (`databricks_volumes`) +- [Dropbox](/platform-api/api/sources/dropbox) (`dropbox`) +- [Elasticsearch](/platform-api/api/sources/elasticsearch) (`elasticsearch`) +- [Google Cloud Storage](/platform-api/api/sources/google-cloud) (`gcs`) +- [Google Drive](/platform-api/api/sources/google-drive) (`google_drive`) +- [Kafka](/platform-api/api/sources/kafka) (`kafka-cloud`) +- [MongoDB](/platform-api/api/sources/mongodb) (`mongodb`) +- [OneDrive](/platform-api/api/sources/onedrive) (`onedrive`) +- [Outlook](/platform-api/api/sources/outlook) (`outlook`) +- [PostgreSQL](/platform-api/api/sources/postgresql) (`postgres`) +- [S3](/platform-api/api/sources/s3) (`s3`) +- [Salesforce](/platform-api/api/sources/salesforce) (`salesforce`) +- [SharePoint](/platform-api/api/sources/sharepoint) (`sharepoint`) +- [Snowflake](/platform-api/api/sources/snowflake) (`snowflake`) + diff --git a/platform-api/api/sources/postgresql.mdx b/platform-api/api/sources/postgresql.mdx index 6ca1f4de..689d46ab 100644 --- a/platform-api/api/sources/postgresql.mdx +++ b/platform-api/api/sources/postgresql.mdx @@ -29,4 +29,4 @@ import PostgreSQLAPIPlaceholders from '/snippets/general-shared-text/postgresql- To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/s3.mdx b/platform-api/api/sources/s3.mdx index 82911aa1..8f4283cc 100644 --- a/platform-api/api/sources/s3.mdx +++ b/platform-api/api/sources/s3.mdx @@ -29,4 +29,4 @@ import S3APIPlaceholders from '/snippets/general-shared-text/s3-api-placeholders To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/salesforce.mdx b/platform-api/api/sources/salesforce.mdx index c02f8b91..4e135f4b 100644 --- a/platform-api/api/sources/salesforce.mdx +++ b/platform-api/api/sources/salesforce.mdx @@ -29,4 +29,4 @@ import SalesforceAPIPlaceholders from '/snippets/general-shared-text/salesforce- To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/sharepoint.mdx b/platform-api/api/sources/sharepoint.mdx index 0abdebca..feb6adcd 100644 --- a/platform-api/api/sources/sharepoint.mdx +++ b/platform-api/api/sources/sharepoint.mdx @@ -29,4 +29,4 @@ import SharePointAPIPlaceholders from '/snippets/general-shared-text/sharepoint- To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/sources/snowflake.mdx b/platform-api/api/sources/snowflake.mdx index af86d227..b87e5217 100644 --- a/platform-api/api/sources/snowflake.mdx +++ b/platform-api/api/sources/snowflake.mdx @@ -29,4 +29,4 @@ import SnowflakeAPIPlaceholders from '/snippets/general-shared-text/snowflake-ap To change a connector, replace `` with the source connector's unique ID. -To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors). \ No newline at end of file +To get this ID, see [List source connectors](/platform-api/api/overview#list-source-connectors). \ No newline at end of file diff --git a/platform-api/api/workflows.mdx b/platform-api/api/workflows.mdx index 5277f894..7cf14044 100644 --- a/platform-api/api/workflows.mdx +++ b/platform-api/api/workflows.mdx @@ -2,23 +2,23 @@ title: Workflows --- -To use the [Unstructured Platform Workflow Endpoint](/platform/api/overview) to manage workflows, do the following: +To use the [Unstructured Platform Workflow Endpoint](/platform-api/api/overview) to manage workflows, do the following: - To get a list of available workflows, use the `UnstructuredClient` object's `workflows.list_workflows` function (for the Python SDK) or - the `GET` method to call the `/workflows` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#list-workflows). + the `GET` method to call the `/workflows` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#list-workflows). - To get information about a workflow, use the `UnstructuredClient` object's `workflows.get_workflow` function (for the Python SDK) or - the `GET` method to call the `/workflows/` endpoint (for `curl` or Postman)use the `GET` method to call the `/workflows/` endpoint. [Learn more](/platform/api/overview#get-a-workflow). + the `GET` method to call the `/workflows/` endpoint (for `curl` or Postman)use the `GET` method to call the `/workflows/` endpoint. [Learn more](/platform-api/api/overview#get-a-workflow). - To create a workflow, use the `UnstructuredClient` object's `workflows.create_workflow` function (for the Python SDK) or the `POST` method to call the `/workflows` endpoint (for `curl` or Postman). [Learn more](#create-a-workflow). - To run a workflow manually, use the `UnstructuredClient` object's `workflows.run_workflow` function (for the Python SDK) or - the `POST` method to call the `/workflows//run` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#run-a-workflow). + the `POST` method to call the `/workflows//run` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#run-a-workflow). - To update a workflow, use the `UnstructuredClient` object's `workflows.update_workflow` function (for the Python SDK) or the `PUT` method to call the `/workflows/` endpoint (for `curl` or Postman). [Learn more](#update-a-workflow). - To delete a workflow, use the `UnstructuredClient` object's `workflows.delete_workflow` function (for the Python SDK) or - the `DELETE` method to call the `/workflows/` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#delete-a-workflow). + the `DELETE` method to call the `/workflows/` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#delete-a-workflow). -The following examples assume that you have already met the [requirements](/platform/api/overview#requirements) and -understand the [basics](/platform/api/overview#basics) of working with the Unstructured Platform Workflow Endpoint. +The following examples assume that you have already met the [requirements](/platform-api/api/overview#requirements) and +understand the [basics](/platform-api/api/overview#basics) of working with the Unstructured Platform Workflow Endpoint. ## Create a workflow @@ -186,10 +186,10 @@ Replace the preceding placeholders as follows: - `` (_required_) - A unique name for this workflow. - `` (_required_) - The ID of the target source connector. To get the ID, use the `UnstructuredClient` object's `sources.list_sources` function (for the Python SDK) or - the `GET` method to call the `/sources` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#list-source-connectors). + the `GET` method to call the `/sources` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#list-source-connectors). - `` (_required_) - The ID of the target destination connector. To get the ID, use the `UnstructuredClient` object's `destinations.list_destinations` function (for the Python SDK) or - the `GET` method to call the `/destinations` endpoint (for `curl` or Postman). [Learn more](/platform/api/overview#list-destination-connectors). + the `GET` method to call the `/destinations` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#list-destination-connectors). - `` (for the Python SDK) or `` (for `curl` or Postman) (_required_) - The workflow optimization type. [Learn more](/platform/partitioning). Available values include `ADVANCED`, `BASIC`, `PLATINUM`, and `CUSTOM` (for the Python SDK) or `advanced`, `basic`, `platinum`, and `custom` (for `curl` or Postman). @@ -217,7 +217,7 @@ the `PUT` method to call the `/workflows/` endpoint (for `curl` or `` with the workflow's unique ID. To get this ID, see [List workflows](#list-workflows). In the request body, specify the settings for the workflow. For the specific settings to include, see -[Create a workflow](/platform/api/workflows#create-a-workflow). +[Create a workflow](/platform-api/api/workflows#create-a-workflow). diff --git a/platform-api/legacy-api/free-api.mdx b/platform-api/legacy-api/free-api.mdx index 0533b24b..72fddbc7 100644 --- a/platform-api/legacy-api/free-api.mdx +++ b/platform-api/legacy-api/free-api.mdx @@ -78,7 +78,7 @@ After the command successfully runs, see the results in the specified output pat ### Unstructured Ingest Python library -To work with Unstructured by using the [Unstructured Python library](/ingestion/overview#unstructured-ingest-python-library), you will need to: +To work with Unstructured by using the [Unstructured Python library](/ingestion/python-ingest), you will need to: - Install Python, and then install the CLI package: diff --git a/platform-api/overview.mdx b/platform-api/overview.mdx index 428d6647..81065eb5 100644 --- a/platform-api/overview.mdx +++ b/platform-api/overview.mdx @@ -4,11 +4,11 @@ title: Overview The Unstructured Platform API consists of two parts: -- The [Unstructured Platform Workflow Endpoint](/platform/api/overview) enables a full range of partitioning, chunking, embedding, and +- The [Unstructured Platform Workflow Endpoint](/platform-api/api/overview) enables a full range of partitioning, chunking, embedding, and enrichment options for your files and data. It is designed to batch-process files and data in remote locations; send processed results to various storage, databases, and vector stores; and use the latest and highest-performing models on the market today. It has built-in logic to deliver the highest quality results at the lowest cost. [Learn more](/platform-api/api/overview). -- The [Unstructured Platform Partition Endpoint](platform/partition-api/overview) is intended for rapid prototyping of Unstructured's +- The [Unstructured Platform Partition Endpoint](/platform-api/partition-api/overview) is intended for rapid prototyping of Unstructured's various partitioning strategies, with limited support for chunking. It is designed to work only with processing of local files, one file at a time. Use the [Unstructured Platform Workflow Endpoint](/platform-api/api/overview) for production-level scenarios, file processing in batches, files and data in remote locations, generating embeddings, applying post-transform enrichments, using the latest and diff --git a/platform-api/partition-api/api-parameters.mdx b/platform-api/partition-api/api-parameters.mdx index 11ae7969..b61f665f 100644 --- a/platform-api/partition-api/api-parameters.mdx +++ b/platform-api/partition-api/api-parameters.mdx @@ -16,7 +16,7 @@ The only required parameter is `files` - the file you wish to process. | `content_type` (_str_) | `contentType` (_string_) | A hint to Unstructured about the content type to use (such as `text/markdown`), when there are problems processing a specific file. This value is a MIME type in the format `type/subtype`. For available MIME types, see [model.py](https://github.com/Unstructured-IO/unstructured/blob/main/unstructured/file_utils/model.py). | | `coordinates` (_bool_) | `coordinates` (_boolean_) | True to return bounding box coordinates for each element extracted with OCR. Default: false. [Learn more](/platform-api/partition-api/examples#saving-bounding-box-coordinates). | | `encoding` (_str_) | `encoding` (_string_) | The encoding method used to decode the text input. Default: `utf-8`. | -| `extract_image_block_types` (_List[str]_) | `extractImageBlockTypes` (_string[]_) | The types of elements to extract, for use in extracting image blocks as Base64 encoded data stored in element metadata fields, for example: `["Image","Table"]`. Supported filetypes are image and PDF. [Learn more](/api-reference/how-to/extract-image-block-types). | +| `extract_image_block_types` (_List[str]_) | `extractImageBlockTypes` (_string[]_) | The types of elements to extract, for use in extracting image blocks as Base64 encoded data stored in element metadata fields, for example: `["Image","Table"]`. Supported filetypes are image and PDF. [Learn more](/platform-api/partition-api/extract-image-block-types). | | `gz_uncompressed_content_type` (_str_) | `gzUncompressedContentType` (_string_) | If file is gzipped, use this content type after unzipping. Example: `application/pdf` | | `hi_res_model_name` (_str_) | `hiResModelName` (_string_) | The name of the inference model used when strategy is `hi_res`. Options are `layout_v1.1.0` and `yolox`. Default: `layout_v1.1.0`. [Learn more](/platform-api/partition-api/examples#changing-partition-strategy-for-a-pdf). | | `include_page_breaks` (_bool_) | `includePageBreaks` (_boolean_) | True for the output to include page breaks if the filetype supports it. Default: false. | diff --git a/platform-api/partition-api/embedding.mdx b/platform-api/partition-api/embedding.mdx index 19c2f7ab..c3ce52bd 100644 --- a/platform-api/partition-api/embedding.mdx +++ b/platform-api/partition-api/embedding.mdx @@ -3,14 +3,14 @@ title: Set embedding behavior --- - The following information applies only to the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) and the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library). + The following information applies only to the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) and the [Unstructured Ingest Python library](/ingestion/python-ingest). The Unstructured SDKs for Python and JavaScript/TypeScript, and the Unstructured open-source library, do not support this functionality. ## Concepts -You can use the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) or the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library) +You can use the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) or the [Unstructured Ingest Python library](/ingestion/python-ingest) to generate _embeddings_ after the partitioning and chunking steps in an ingest pipeline. The chunking step is particularly important to ensure that the text pieces (also known as the _documents_ or _elements_) can fit the input limits of an _embedding model_. diff --git a/platform-api/partition-api/extract-image-block-types.mdx b/platform-api/partition-api/extract-image-block-types.mdx index 18242a64..fa930698 100644 --- a/platform-api/partition-api/extract-image-block-types.mdx +++ b/platform-api/partition-api/extract-image-block-types.mdx @@ -26,7 +26,7 @@ import ExtractImageBlockTypesPy from '/snippets/how-to-api/extract_image_block_t - For the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library), you can use the standard Python + For the [Unstructured Ingest Python library](/ingestion/python-ingest), you can use the standard Python [json.load](https://docs.python.org/3/library/json.html#json.load) function to load into a Python dictionary the contents of a JSON file that the Ingest Python library outputs after the processing is complete. diff --git a/platform-api/partition-api/filter-files.mdx b/platform-api/partition-api/filter-files.mdx index d693fca0..3efabb6a 100644 --- a/platform-api/partition-api/filter-files.mdx +++ b/platform-api/partition-api/filter-files.mdx @@ -3,7 +3,7 @@ title: Process a subset of files --- - The following information applies only to the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) and the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library). + The following information applies only to the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) and the [Unstructured Ingest Python library](/ingestion/python-ingest). The Unstructured SDKs for Python and JavaScript/TypeScript and the Unstructured open-source library do not support this functionality. diff --git a/platform-api/partition-api/get-chunked-elements.mdx b/platform-api/partition-api/get-chunked-elements.mdx index 20a24017..020d8933 100644 --- a/platform-api/partition-api/get-chunked-elements.mdx +++ b/platform-api/partition-api/get-chunked-elements.mdx @@ -58,7 +58,7 @@ import SharedAPIKeyURL from '/snippets/general-shared-text/api-key-url.mdx'; - For the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library), you can use the standard Python + For the [Unstructured Ingest Python library](/ingestion/python-ingest), you can use the standard Python [json.load](https://docs.python.org/3/library/json.html#json.load) function to load into a Python dictionary the contents of a JSON file that the Ingest Python library outputs after the processing is complete. diff --git a/platform-api/partition-api/get-elements.mdx b/platform-api/partition-api/get-elements.mdx index 7c9d2333..212a49c5 100644 --- a/platform-api/partition-api/get-elements.mdx +++ b/platform-api/partition-api/get-elements.mdx @@ -4,7 +4,7 @@ title: Get element contents ## Task -You want to get, manipulate, and print or save, the contents of the [document elements and metadata](/latform-api/partition-api/document-elements) from the processed data that Unstructured returns. +You want to get, manipulate, and print or save, the contents of the [document elements and metadata](/platform-api/partition-api/document-elements) from the processed data that Unstructured returns. ## Approach @@ -29,7 +29,7 @@ The programmatic approach you take to get these document elements will depend on ``` - For the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library), you can use the standard Python + For the [Unstructured Ingest Python library](/ingestion/python-ingest), you can use the standard Python [json.load](https://docs.python.org/3/library/json.html#json.load) function to load into a Python dictionary the contents of a JSON file that the Ingest Python library outputs after the processing is complete. diff --git a/platform-api/partition-api/overview.mdx b/platform-api/partition-api/overview.mdx index 0f9a4568..43d6d50d 100644 --- a/platform-api/partition-api/overview.mdx +++ b/platform-api/partition-api/overview.mdx @@ -67,12 +67,13 @@ To call the Unstructured Platform Partition Endpoint, you need an Unstructured a ![Unstructured account settings](/img/platform/AccountSettings.png) - ![Unstructured API key and API URL](/img/platform/APIKeyOnly.png) + ![Unstructured API key](/img/platform/APIKeyOnly.png) - 1. After you have signed in to your Unstructured account, at the bottom of the sidebar, click your user icon, and then click **Account Settings**. - 2. On the **API Keys** tab, click **Generate New Key**. - 3. Enter some descriptive name for the API key, and then click **Save**. - 4. Click the **Copy** icon for your new API key. The API key's value is copied to your system's clipboard. + 1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). + 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. + 3. On the **API Keys** tab, click **Generate New Key**. + 4. Enter some descriptive name for the API key, and then click **Save**. + 5. Click the **Copy** icon for your new API key. The API key's value is copied to your system's clipboard. @@ -94,7 +95,7 @@ the Unstructured Platform Partition API: ![Unstructured account payment method](/img/platform/AccountBillingPaymentMethod.png) -1. Sign in to the Unstructured Platform. +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. 3. Click the **Billing** tab. 4. Click **Manage Payment Method**, follow the on-screen instructions to enter or update your payment details, and then click **Save card**. diff --git a/platform-api/partition-api/speed-up-large-files-batches.mdx b/platform-api/partition-api/speed-up-large-files-batches.mdx index 66c3a9fe..696c0377 100644 --- a/platform-api/partition-api/speed-up-large-files-batches.mdx +++ b/platform-api/partition-api/speed-up-large-files-batches.mdx @@ -4,7 +4,7 @@ title: Speed up processing of large files and batches When you use Unstructured, here are some techniques that you can try to help speed up the processing of large files and large batches of files. -- Choose your partitioning strategy wisely. For example, if you have simple PDFs that don't have images and tables, you might be able to use the `fast` strategy. Try the `fast` strategy on a few of your documents before you try using the `hi_res` strategy. [Learn more](/api-reference/api-services/partitioning). +- Choose your partitioning strategy wisely. For example, if you have simple PDFs that don't have images and tables, you might be able to use the `fast` strategy. Try the `fast` strategy on a few of your documents before you try using the `hi_res` strategy. [Learn more](/platform-api/partition-api/partitioning). - For processing large numbers of documents, use [ingestion](/ingestion/overview) and [add CPUs](#adding-cpus). - For processing large individual PDF files with the Unstructured SDKs, [use PDF splitting parameters](#pdf-files). @@ -70,11 +70,11 @@ In Python, to specify the maximum number of available local logical CPUs that ca ## PDF files -To speed up PDF file processing, the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli), the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library), the [Unstructured SDK for Python](/api-reference/api-services/sdk-python), and the [Unstructured SDK for JavaScript/TypeScript](/api-reference/api-services/sdk-jsts) provide the following parameters to help speed up processing a large PDF file: +To speed up PDF file processing, the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli), the [Unstructured Ingest Python library](/ingestion/python-ingest), the [Unstructured SDK for Python](/platform-api/partition-api/sdk-python), and the [Unstructured SDK for JavaScript/TypeScript](/platform-api/partition-api/sdk-jsts) provide the following parameters to help speed up processing a large PDF file: - `split_pdf_page` (CLI/Python) or `splitPdfPage` (JavaScript/TypeScript), when set to true, splits the PDF file on the client side before sending it as batches to Unstructured for processing. The number of pages in each batch is determined internally. Batches can contain between 2 and 20 pages. - `split_pdf_concurrency_level` (CLI/Python) or `splitPdfConcurrencyLevel` (JavaScript/TypeScript) is an integer that specifies the number of parallel requests. The default is 5. The maximum is 15. This behavior is ignored unless `split_pdf_page` (CLI/Python) or `splitPdfPage` (JavaScript/TypeScript) is also set to true. - `split_pdf_allow_failed` (CLI/Python) or splitPdfAllowFailed` (JavaScript/TypeScript), when set to true, allows partitioning to continue even if some pages fail. - `split_pdf_page_range` (CLI/Python only) is a list of two integers that specify the beginning and ending page numbers of the PDF file to be sent. A `ValueError` is raised if the specified range is not valid. This behavior is ignored unless `split_pdf_page` is also set to true. -[Learn more](/api-reference/api-services/sdk#page-splitting). +[Learn more](/platform-api/partition-api/sdk-python#page-splitting). diff --git a/platform-api/partition-api/text-as-html.mdx b/platform-api/partition-api/text-as-html.mdx index 1867c129..7601ce4c 100644 --- a/platform-api/partition-api/text-as-html.mdx +++ b/platform-api/partition-api/text-as-html.mdx @@ -24,7 +24,7 @@ import ExtractTextAsHTMLPy from '/snippets/how-to-api/extract_text_as_html.py.md - For the [Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library), you can use the standard Python + For the [Unstructured Ingest Python library](/ingestion/python-ingest), you can use the standard Python [json.load](https://docs.python.org/3/library/json.html#json.load) function to load into a Python dictionary the contents of a JSON file that the Ingest Python library outputs after the processing is complete. diff --git a/platform-api/troubleshooting/api-key-url.mdx b/platform-api/troubleshooting/api-key-url.mdx index 79cbb3da..e47c06bc 100644 --- a/platform-api/troubleshooting/api-key-url.mdx +++ b/platform-api/troubleshooting/api-key-url.mdx @@ -37,14 +37,14 @@ API error occurred: Status 404 For the API URL, note the following: -- For the [Unstructured Platform Workflow Endpoint](/platform/api/overview), the API URL is typically `https://platform.unstructuredapp.io/api/v1`. +- For the [Unstructured Platform Workflow Endpoint](/platform-api/api/overview), the API URL is typically `https://platform.unstructuredapp.io/api/v1`. - For the [Unstructured Platform Partition Endpoint](/platform-api/partition-api/overview), the API URL is typically `https://api.unstructuredapp.io/general/v0/general`. -For the API key, the same API key works for both the [Unstructured Platform Workflow Endpoint](/platform/api/overview) key or [Unstructured Platform Partition Endpoint](/platform-api/partition-api/overview). This API key is in your Unstructured account dashboard. To access your dashboard: +For the API key, the same API key works for both the [Unstructured Platform Workflow Endpoint](/platform-api/api/overview) key or [Unstructured Platform Partition Endpoint](/platform-api/partition-api/overview). This API key is in your Unstructured account dashboard. To access your dashboard: ![Unstructured account settings](/img/platform/AccountSettings.png) - 1. Sign in to your Unstructured account. + 1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. 3. On the **API Keys** tab, click the copy icon next to your key. @@ -52,7 +52,7 @@ For the API URL, note the value of the the Unstructured **Platform API URL** (fo ![Unstructured Serverless and Platform API URLs](/img/platform/ServerlessPlatformAPIURL.png) - 1. Sign in to your Unstructured account. + 1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. 3. On the **API Keys** tab, note the correct API URL. These APIs are not interchangeable between the Workflow and Partition APIs. diff --git a/platform/billing.mdx b/platform/billing.mdx index cfdfdd55..30ac4da6 100644 --- a/platform/billing.mdx +++ b/platform/billing.mdx @@ -24,7 +24,7 @@ you must provide Unstructured with your payment details to continue using the se ![Unstructured account payment method](/img/platform/AccountBillingPaymentMethod.png) -1. Sign in to the Unstructured Platform. +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. 3. Click the **Billing** tab. 4. Click **Manage Payment Method**, follow the on-screen instructions to enter or update your payment details, and then click **Save card**. @@ -41,7 +41,7 @@ Go to the [Unstructured Subscribe & Save](https://unstructured.io/subscribeandsa ![Unstructured account pay-per-page billing](/img/platform/AccountBillingPayPerPage.png) -1. Sign in to the Unstructured Platform. +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. 3. Click the **Billing** tab. A billing overview for the current month and a list of your billing invoices are displayed. @@ -51,7 +51,7 @@ Go to the [Unstructured Subscribe & Save](https://unstructured.io/subscribeandsa ![Unstructured account subscribe-and-save budget amounts](/img/platform/AccountBillingSubscribeAndSave.png) -1. Sign in to the Unstructured Platform. +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. 3. Click the **Billing** tab. The available and used budgets for your current plan are displayed. @@ -69,7 +69,7 @@ To view usage details for your Unstructured account, do the following: ![Unstructured account billing usage](/img/platform/AccountUsage.png) -1. Sign in to the Unstructured Platform. +1. Sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. 3. Click the **Usage History** tab. diff --git a/platform/connectors.mdx b/platform/connectors.mdx index 2c6cfb33..3f55e6ac 100644 --- a/platform/connectors.mdx +++ b/platform/connectors.mdx @@ -32,7 +32,7 @@ The Unstructured Platform supports connecting to the following source and destin If your source is not listed here, you might still be able to connect Unstructured to it through scripts or code by using the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) or the -[Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library). +[Unstructured Ingest Python library](/ingestion/python-ingest). [Learn more](/ingestion/source-connectors/overview). ## Destinations @@ -61,6 +61,6 @@ If your source is not listed here, you might still be able to connect Unstructur If your destination is not listed here, you might still be able to connect Unstructured to it through scripts or code by using the [Unstructured Ingest CLI](/ingestion/overview#unstructured-ingest-cli) or the -[Unstructured Ingest Python library](/ingestion/overview#unstructured-ingest-python-library). -[Learn more](/ingestion/destination-connector/overview). +[Unstructured Ingest Python library](/ingestion/python-ingest). +[Learn more](/ingestion/destination-connectors/overview). diff --git a/snippets/general-shared-text/azure-ai-search.mdx b/snippets/general-shared-text/azure-ai-search.mdx index adf9c5a5..0ebb8b39 100644 --- a/snippets/general-shared-text/azure-ai-search.mdx +++ b/snippets/general-shared-text/azure-ai-search.mdx @@ -923,4 +923,4 @@ Here are some more details about these requirements: - [Search indexes in Azure AI Search](https://learn.microsoft.com/azure/search/search-what-is-an-index) - [Schema of a search index](https://learn.microsoft.com/azure/search/search-what-is-an-index#schema-of-a-search-index) - [Example index schema](https://learn.microsoft.com/rest/api/searchservice/create-index#examples) - - [Unstructured document elements and metadata](/latform-api/partition-api/document-elements) \ No newline at end of file + - [Unstructured document elements and metadata](/platform-api/partition-api/document-elements) \ No newline at end of file diff --git a/snippets/general-shared-text/elasticsearch.mdx b/snippets/general-shared-text/elasticsearch.mdx index 3735ee61..a42914d1 100644 --- a/snippets/general-shared-text/elasticsearch.mdx +++ b/snippets/general-shared-text/elasticsearch.mdx @@ -85,7 +85,7 @@ - [An Introduction to Elasticsearch Mapping](https://www.elastic.co/blog/found-elasticsearch-mapping-introduction) - [Explicit mapping](https://www.elastic.co/guide/en/elasticsearch/reference/current/explicit-mapping.html) - [Dynamic field mapping](https://www.elastic.co/guide/en/elasticsearch/reference/current/dynamic-field-mapping.html) - - [Unstructured document elements and metadata](/latform-api/partition-api/document-elements) + - [Unstructured document elements and metadata](/platform-api/partition-api/document-elements) -Unstructured offers the Unstructured Platform user interface (UI) and the Unstructured Platform API. Click inside one of the following cards to learn more. +Unstructured offers the Unstructured Platform user interface (UI) and the Unstructured Platform API. Read on to learn more. ## Unstructured Platform user interface (UI)