From 5cb6504d5af3d034c9601cbb37b56e37ea8e0711 Mon Sep 17 00:00:00 2001 From: Christine Straub Date: Fri, 23 Feb 2024 20:36:58 -0800 Subject: [PATCH] docs: update image block extraction docs (#2578) This PR removes `extract_image_block_to_payload` section from "API Parameters" page. The "unstructured" API does not support the `extract_image_block_to_payload` parameter, and it is always set to `True` internally on the API side when trying to extract image blocks via the API. Users only need to specify `extract_image_block_types` parameter when extracting image blocks via the API. **NOTE:** The `extract_image_block_to_payload` parameter is only used when calling `partition()`, `partition_pdf()`, and `partition_image()` functions directly. ### Testing CI should pass. --- docs/source/apis/api_parameters.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/source/apis/api_parameters.rst b/docs/source/apis/api_parameters.rst index a678b0b75..c5358765c 100644 --- a/docs/source/apis/api_parameters.rst +++ b/docs/source/apis/api_parameters.rst @@ -106,9 +106,3 @@ extract_image_block_types - **Type**: array - **Description**: The types of image blocks to extract from the document. Supports various Element types. - **Example**: ['Image', 'Table'] - -extract_image_block_to_payload ------------------------------- -- **Type**: boolean -- **Description**: This parameter facilitates the inclusion of element data directly within the payload, especially for web-based applications or APIs. -- **Example**: true \ No newline at end of file