yujunjun/unstructured
1
0
Fork 0
mirror of https://github.com/Unstructured-IO/unstructured.git synced 2025-10-13 17:16:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update image block extraction docs (#2578)

Browse Source 
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.
This commit is contained in:
Christine Straub 2024-02-23 20:36:58 -08:00 committed by GitHub
parent e8ec09c8b9
commit 5cb6504d5a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 0 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/apis/api_parameters.rst
View File

@ -106,9 +106,3 @@ extract_image_block_types
- **Type**: array - **Type**: array
- **Description**: The types of image blocks to extract from the document. Supports various Element types. - **Description**: The types of image blocks to extract from the document. Supports various Element types.
- **Example**: ['Image', 'Table'] - **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