Merge branch 'Unstructured-IO:main' into main

Author: fzowl

README.md

@@ -17,8 +17,8 @@ Everyone is welcome to contribute, and you can do it in a couple of ways:
 
 To contribute changes to the documentation:
 
-1. Fork the repo.
-2. Create a new branch with a descriptive name.
+1. If you're not a member of Unstructured team, start by forking the repo. If you are part of the team, you can clone this repo. 
+2. Create a new branch with a descriptive name. 
 3. Add your changes. DO NOT MANUALLY EDIT THE CONTENTS OF THE `snippets/destination_connectors` and `snippets/source_connectors` FOLDERS. These are auto-generated from tested code examples. 
 4. Check for grammatical and technical correctness of the changes. 
 5. Preview your changes locally. [See how below](#previewing-documentation-changes-locally). 

api-reference/api-services/accessing-unstructured-api.mdx

@@ -2,24 +2,33 @@
 title: Overview
 ---
 
-Whether you're using the free Unstructured API, the SaaS Unstructured API, Unstructured API on Azure/AWS or your local
-deployment of Unstructured API, you have several methods of accessing it. The functionality is the same across different methods.
+To process an individual file, you can choose from several available methods, including a direct `POST` request, Python code, and JavaScript/TypeScript code. 
+Whether you're using the Free Unstructured API, the Unstructured Serverless API, the Unstructured API on Azure/AWS, or your local deployment of the Unstructured API, the functionality is the same.
 
 Choose your preferred method:
 
-* [Sending POST requests to Unstructured API](/api-reference/api-services/post-requests)
-* [Using Python SDK](/api-reference/api-services/python-sdk)
-* [Using JavaScript SDK](/api-reference/api-services/javascript-sdk)
-* [Using API by calling `partition_via_api()` from Python code](/api-reference/api-services/partition-via-api)
+* [Use the Unstructured Python SDK](/api-reference/api-services/sdk-python)
+* [Use the Unstructured JavaScript/TypeScript SDK](/api-reference/api-services/sdk-jsts)
+* [Use the Unstructured open source Python library](/api-reference/api-services/partition-via-api)
+* [Make a direct POST request](/api-reference/api-services/post-requests)
 
 The API parameters for all these methods are documented on the [API parameters](/api-reference/api-services/api-parameters) page.
 
-If you'd like to try out the Unstructured API interactively, you can do so via the [Swagger UI](https://api.unstructured.io/general/docs#/default/pipeline_1_general_v0_general_post).
-Make sure to have your API key on hand.
+import UseIngestInstead from '/snippets/general-shared-text/use-ingest-instead.mdx';
 
-1. Go to  [Swagger UI](https://api.unstructured.io/general/docs#/default/pipeline_1_general_v0_general_post).
-2. Click "Try it out" for interactive testing.
-3. Enter your API key in the "unstructured-api-key" field.
-4. Choose your parameters in the "Request body".
-5. Click "execute" to send the request.
-6. Download or view the JSON output.
+<UseIngestInstead />
+
+If you'd like to try out the Unstructured API interactively by using the Free Unstructured API to process a single file, you can do so by using the [Swagger UI](https://api.unstructured.io/general/docs#/default/pipeline_1_general_v0_general_post).
+
+1. Go to the [Swagger UI](https://api.unstructured.io/general/docs#/default/pipeline_1_general_v0_general_post).
+2. For **Servers**, select **https://api.unstructured.io - Hosted API Free**.
+2. Click **Authorize**.
+3. In the **Available authorizations** dialog box, for **Value**, enter your Free Unstructured API key. [Get a Free Unstructured API key](/api-reference/api-services/free-api#get-an-api-key).
+4. Click **Authorize**.
+5. Click **Close**.
+6. Expand the **POST** section.
+7. In the **Request body** section, next to **files**, click **Choose File**.
+8. Browse to and select a file for the Free Unstructured API to process.
+9. Enter any other settings as desired. [Learn how](/api-reference/api-services/api-parameters).
+10. At the end of the list of settings, click **Execute**.
+11. See the results in the **Responses** section below the **Execute** button.

api-reference/api-services/api-parameters.mdx

@@ -1,5 +1,5 @@
 ---
-title: API Validation Errors 
+title: API validation errors 
 description: This section details the structure of HTTP validation errors returned by the API.
 ---
 

api-reference/api-services/api-validation-errors.mdx

@@ -19,10 +19,13 @@ text element that was too big to fit in one chunk and required splitting.
 * `Table`:  A table element is not combined with other elements and if it fits within `max_characters` it will remain as is.
 * `TableChunk`: large tables that exceed `max_characters` chunk size are split into special `TableChunk` elements.
 
+import SharedChunkingStrategyBasic from '/snippets/concepts/chunking-strategy-basic.mdx';
 
-import SharedChunkingStrategies from '/snippets/concepts/chunking-strategies.mdx';
+<SharedChunkingStrategyBasic/>
 
-<SharedChunkingStrategies/>
+import SharedChunkingStrategyByTitle from '/snippets/concepts/chunking-strategy-by-title.mdx';
+
+<SharedChunkingStrategyByTitle/>
 
 ### "by_page" chunking strategy
 
@@ -46,3 +49,9 @@ guarantee that two elements with low similarity will not be combined in a single
 You can control the level of topic similarity you require for elements to have by setting the `similarity_threshold` parameter.
 `similarity_threshold` expects a value between 0.0 and 1.0 specifying the minimum similarity text in consecutive elements
 must have to be included in the same chunk. The default is 0.5.
+
+### 
+
+## Learn more
+
+<Icon icon="blog" />&nbsp;&nbsp;[Chunking for RAG: best practices](https://unstructured.io/blog/chunking-for-rag-best-practices)