- bump
unstructured-inference
to0.6.6
The updated version ofunstructured-inference
makes table extraction inhi_res
mode configurable to fine tune table extraction performance; it also improves element detection by adding a deduplication post processing step in thehi_res
partitioning of pdfs and images. - Update python-based docs Refactor docs to use the actual unstructured code rather than using the subprocess library to run the cli command itself.
- Adds data source properties to SharePoint, Outlook, Onedrive, Reddit, and Slack connectors These properties (date_created, date_modified, version, source_url, record_locator) are written to element metadata during ingest, mapping elements to information about the document source from which they derive. This functionality enables downstream applications to reveal source document applications, e.g. a link to a GDrive doc, Salesforce record, etc.
- Fix various cases of HTML text missing after partition Problem: Under certain circumstances, text immediately after some HTML tags will be misssing from partition result. Fix: Updated code to deal with these cases. Importance: This will ensure the correctness when partitioning HTML and Markdown documents.
- Better detection of natural reading order in images and PDF's The elements returned by partition better reflect natural reading order in some cases, particularly in complicated multi-column layouts, leading to better chunking and retrieval for downstream applications. Achieved by improving the
xy-cut
sorting to preprocess bboxes, shrinking all bounding boxes by 90% along x and y axes (still centered around the same center point), which allows projection lines to be drawn where not possible before if layout bboxes overlapped. - Improves
partition_xml
to be faster and more memory efficient when partitioning large XML files The new behavior is to partition iteratively to prevent loading the entire XML tree into memory at once in most use cases. - Adds data source properties to SharePoint, Outlook, Onedrive, Reddit, Slack, and DeltaTable connectors These properties (date_created, date_modified, version, source_url, record_locator) are written to element metadata during ingest, mapping elements to information about the document source from which they derive. This functionality enables downstream applications to reveal source document applications, e.g. a link to a GDrive doc, Salesforce record, etc.
- Add functionality to save embedded images in PDF's separately as images This allows users to save embedded images in PDF's separately as images, given some directory path. The saved image path is written to the metadata for the Image element. Downstream applications may benefit by providing users with image links from relevant "hits."
- Azure Cognite Search destination connector New Azure Cognitive Search destination connector added to ingest CLI. Users may now use
unstructured-ingest
to write partitioned data from over 20 data sources (so far) to an Azure Cognitive Search index. - Improves salesforce partitioning Partitions Salesforce data as xlm instead of text for improved detail and flexibility. Partitions htmlbody instead of textbody for Salesforce emails. Importance: Allows all Salesforce fields to be ingested and gives Salesforce emails more detailed partitioning.
- Add document level language detection functionality. Introduces the "auto" default for the languages param, which then detects the languages present in the document using the
langdetect
package. Adds the document languages as ISO 639-3 codes to the element metadata. Implemented only for the partition_text function to start. - PPTX partitioner refactored in preparation for enhancement. Behavior should be unchanged except that shapes enclosed in a group-shape are now included, as many levels deep as required (a group-shape can itself contain a group-shape).
- Embeddings support for the SharePoint SourceConnector via unstructured-ingest CLI The SharePoint connector can now optionally create embeddings from the elements it pulls out during partition and upload those embeddings to Azure Cognitive Search index.
- Improves hierarchy from docx files by leveraging natural hierarchies built into docx documents Hierarchy can now be detected from an indentation level for list bullets/numbers and by style name (e.g. Heading 1, List Bullet 2, List Number).
- Chunking support for the SharePoint SourceConnector via unstructured-ingest CLI The SharePoint connector can now optionally chunk the elements pulled out during partition via the chunking unstructured brick. This can be used as a stage before creating embeddings.
- Adds
links
metadata inpartition_pdf
forfast
strategy. Problem: PDF files contain rich information and hyperlink that Unstructured did not captured earlier. Feature:partition_pdf
now can capture embedded links within the file along with its associated text and page number. Importance: Providing depth in extracted elements give user a better understanding and richer context of documents. This also enables user to map to other elements within the document if the hyperlink is refered internally. - Adds the embedding module to be able to embed Elements Problem: Many NLP applications require the ability to represent parts of documents in a semantic way. Until now, Unstructured did not have text embedding ability within the core library. Feature: This embedding module is able to track embeddings related data with a class, embed a list of elements, and return an updated list of Elements with the embeddings property. The module is also able to embed query strings. Importance: Ability to embed documents or parts of documents will enable users to make use of these semantic representations in different NLP applications, such as search, retrieval, and retrieval augmented generation.
- Fixes a metadata source serialization bug Problem: In unstructured elements, when loading an elements json file from the disk, the data_source attribute is assumed to be an instance of DataSourceMetadata and the code acts based on that. However the loader did not satisfy the assumption, and loaded it as a dict instead, causing an error. Fix: Added necessary code block to initialize a DataSourceMetadata object, also refactored DataSourceMetadata.from_dict() method to remove redundant code. Importance: Crucial to be able to load elements (which have data_source fields) from json files.
- Fixes issue where unstructured-inference was not getting updated Problem: unstructured-inference was not getting upgraded to the version to match unstructured release when doing a pip install. Solution: using
pip install unstructured[all-docs]
it will now upgrade both unstructured and unstructured-inference. Importance: This will ensure that the inference library is always in sync with the unstructured library, otherwise users will be using outdated libraries which will likely lead to unintended behavior. - Fixes SharePoint connector failures if any document has an unsupported filetype Problem: Currently the entire connector ingest run fails if a single IngestDoc has an unsupported filetype. This is because a ValueError is raised in the IngestDoc's
__post_init__
. Fix: Adds a try/catch when the IngestConnector runs get_ingest_docs such that the error is logged but all processable documents->IngestDocs are still instantiated and returned. Importance: Allows users to ingest SharePoint content even when some files with unsupported filetypes exist there. - Fixes Sharepoint connector server_path issue Problem: Server path for the Sharepoint Ingest Doc was incorrectly formatted, causing issues while fetching pages from the remote source. Fix: changes formatting of remote file path before instantiating SharepointIngestDocs and appends a '/' while fetching pages from the remote source. Importance: Allows users to fetch pages from Sharepoint Sites.
- Fixes badly initialized Formula Problem: YoloX contain new types of elements, when loading a document that contain formulas a new element of that class should be generated, however the Formula class inherits from Element instead of Text. After this change the element is correctly created with the correct class allowing the document to be loaded. Fix: Change parent class for Formula to Text. Importance: Crucial to be able to load documents that contain formulas.
- Fixes Sphinx errors. Fixes errors when running Sphinx
make html
and installs library to suppress warnings. - Fixes a metadata backwards compatibility error Problem: When calling
partition_via_api
, the hosted api may return an element schema that's newer than the currentunstructured
. In this case, metadata fields were added which did not exist in the localElementMetadata
dataclass, and__init__()
threw an error. Fix: remove nonexistent fields before instantiating inElementMetadata.from_json()
. Importance: Crucial to avoid breaking changes when adding fields. - Fixes issue with Discord connector when a channel returns
None
Problem: Getting thejump_url
from a nonexistent Discordchannel
fails. Fix: propertyjump_url
is now retrieved within the same context as the messages from the channel. Importance: Avoids cascading issues when the connector fails to fetch information about a Discord channel. - Fixes occasionally SIGABTR when writing table with
deltalake
on Linux Problem: occasionally on Linux ingest can throw aSIGABTR
when writingdeltalake
table even though the table was written correctly. Fix: put the writing function into aProcess
to ensure its execution to the fullest extent before returning to the main process. Importance: Improves stability of connectors usingdeltalake
- Adds data source properties to Airtable, Confluence, Discord, Elasticsearch, Google Drive, and Wikipedia connectors These properties (date_created, date_modified, version, source_url, record_locator) are written to element metadata during ingest, mapping elements to information about the document source from which they derive. This functionality enables downstream applications to reveal source document applications, e.g. a link to a GDrive doc, Salesforce record, etc.
- DOCX partitioner refactored in preparation for enhancement. Behavior should be unchanged except in multi-section documents containing different headers/footers for different sections. These will now emit all distinct headers and footers encountered instead of just those for the last section.
- Add a function to map between Tesseract and standard language codes. This allows users to input language information to the
languages
param in any Tesseract-supported langcode or any ISO 639 standard language code. - Add document level language detection functionality. Introduces the "auto" default for the languages param, which then detects the languages present in the document using the
langdetect
package. Implemented only for the partition_text function to start.
- *Fixes an issue that caused a partition error for some PDF's. Fixes GH Issue 1460 by bypassing a coordinate check if an element has invalid coordinates.
- Support for better element categories from the next-generation image-to-text model ("chipper"). Previously, not all of the classifications from Chipper were being mapped to proper
unstructured
element categories so the consumer of the library would see manyUncategorizedText
elements. This fixes the issue, improving the granularity of the element categories outputs for better downstream processing and chunking. The mapping update is:- "Threading":
NarrativeText
- "Form":
NarrativeText
- "Field-Name":
Title
- "Value":
NarrativeText
- "Link":
NarrativeText
- "Headline":
Title
(withcategory_depth=1
) - "Subheadline":
Title
(withcategory_depth=2
) - "Abstract":
NarrativeText
- "Threading":
- Better ListItem grouping for PDF's (fast strategy). The
partition_pdf
withfast
strategy previously broke down some numbered list item lines as separate elements. This enhancement leverages the x,y coordinates and bbox sizes to help decide whether the following chunk of text is a continuation of the immediate previous detected ListItem element or not, and not detect it as its own non-ListItem element. - Fall back to text-based classification for uncategorized Layout elements for Images and PDF's. Improves element classification by running existing text-based rules on previously
UncategorizedText
elements. - Adds table partitioning for Partitioning for many doc types including: .html, .epub., .md, .rst, .odt, and .msg. At the core of this change is the .html partition functionality, which is leveraged by the other effected doc types. This impacts many scenarios where
Table
Elements are now propery extracted. - Create and add
add_chunking_strategy
decorator to partition functions. Previously, users were responsible for their own chunking after partitioning elements, often required for downstream applications. Now, individual elements may be combined into right-sized chunks where min and max character size may be specified ifchunking_strategy=by_title
. Relevant elements are grouped together for better downstream results. This enables users immediately use partitioned results effectively in downstream applications (e.g. RAG architecture apps) without any additional post-processing. - Adds
languages
as an input parameter and marksocr_languages
kwarg for deprecation in pdf, image, and auto partitioning functions. Previously, language information was only being used for Tesseract OCR for image-based documents and was in a Tesseract specific string format, but by refactoring into a list of standard language codes independent of Tesseract, theunstructured
library will better supportlanguages
for other non-image pipelines and/or support for other OCR engines. - Removes
UNSTRUCTURED_LANGUAGE
env var usage and replaceslanguage
withlanguages
as an input parameter to unstructured-partition-text_type functions. The previous parameter/input setup was not user-friendly or scalable to the variety of elements being processed. By refactoring the inputted language information into a list of standard language codes, we can support future applications of the element language such as detection, metadata, and multi-language elements. Now, to skip English specific checks, set thelanguages
parameter to any non-English language(s). - Adds
xlsx
andxls
filetype extensions to theskip_infer_table_types
default list inpartition
. By adding these file types to the input parameter these files should not go through table extraction. Users can still specify if they would like to extract tables from these filetypes, but will have to set theskip_infer_table_types
to exclude the desired filetype extension. This avoids mis-representing complex spreadsheets where there may be multiple sub-tables and other content. - Better debug output related to sentence counting internals. Clarify message when sentence is not counted toward sentence count because there aren't enough words, relevant for developers focused on
unstructured
s NLP internals. - Faster ocr_only speed for partitioning PDF and images. Use
unstructured_pytesseract.run_and_get_multiple_output
function to reduce the number of calls totesseract
by half when partitioning pdf or image withtesseract
- Adds data source properties to fsspec connectors These properties (date_created, date_modified, version, source_url, record_locator) are written to element metadata during ingest, mapping elements to information about the document source from which they derive. This functionality enables downstream applications to reveal source document applications, e.g. a link to a GDrive doc, Salesforce record, etc.
- Add delta table destination connector New delta table destination connector added to ingest CLI. Users may now use
unstructured-ingest
to write partitioned data from over 20 data sources (so far) to a Delta Table. - Rename to Source and Destination Connectors in the Documentation. Maintain naming consistency between Connectors codebase and documentation with the first addition to a destination connector.
- Non-HTML text files now return unstructured-elements as opposed to HTML-elements. Previously the text based files that went through
partition_html
would return HTML-elements but now we preserve the format from the input usingsource_format
argument in the partition call. - Adds
PaddleOCR
as an optional alternative toTesseract
for OCR in processing of PDF or Image files, it is installable via themakefile
commandinstall-paddleocr
. For experimental purposes only. - Bump unstructured-inference to 0.5.28. This version bump markedly improves the output of table data, rendered as
metadata.text_as_html
in an element. These changes include:- add env variable
ENTIRE_PAGE_OCR
to specify using paddle or tesseract on entire page OCR - table structure detection now pads the input image by 25 pixels in all 4 directions to improve its recall (0.5.27)
- support paddle with both cpu and gpu and assume it is pre-installed (0.5.26)
- fix a bug where
cells_to_html
doesn't handle cells spanning multiple rows properly (0.5.25) - remove
cv2
preprocessing step before OCR step in table transformer (0.5.24)
- add env variable
- Adds element metadata via
category_depth
with default value None.- This additional metadata is useful for vectordb/LLM, chunking strategies, and retrieval applications.
- Adds a naive hierarchy for elements via a
parent_id
on the element's metadata- Users will now have more metadata for implementing vectordb/LLM chunking strategies. For example, text elements could be queried by their preceding title element.
- Title elements created from HTML headings will properly nest
add_pytesseract_bboxes_to_elements
no longer returnsnan
values. The function logic is now broken into new methods_get_element_box
andconvert_multiple_coordinates_to_new_system
- Selecting a different model wasn't being respected when calling
partition_image
. Problem:partition_pdf
allows for passing amodel_name
parameter. Given the similarity between the image and PDF pipelines, the expected behavior is thatpartition_image
should support the same parameter, butpartition_image
was unintentionally not passing along itskwargs
. This was corrected by adding the kwargs to the downstream call. - Fixes a chunking issue via dropping the field "coordinates". Problem: chunk_by_title function was chunking each element to its own individual chunk while it needed to group elements into a fewer number of chunks. We've discovered that this happens due to a metadata matching logic in chunk_by_title function, and discovered that elements with different metadata can't be put into the same chunk. At the same time, any element with "coordinates" essentially had different metadata than other elements, due each element locating in different places and having different coordinates. Fix: That is why we have included the key "coordinates" inside a list of excluded metadata keys, while doing this "metadata_matches" comparision. Importance: This change is crucial to be able to chunk by title for documents which include "coordinates" metadata in their elements.
- Update all connectors to use new downstream architecture
- New click type added to parse comma-delimited string inputs
- Some CLI options renamed
- Updated documentation: Added back support doc types for partitioning, more Python codes in the API page, RAG definition, and use case.
- Updated Hi-Res Metadata: PDFs and Images using Hi-Res strategy now have layout model class probabilities added ot metadata.
- Updated the
_detect_filetype_from_octet_stream()
function to use libmagic to infer the content type of file when it is not a zip file. - Tesseract minor version bump to 5.3.2
- Add Jira Connector to be able to pull issues from a Jira organization
- Add
clean_ligatures
function to expand ligatures in text
partition_html
breaks on<br>
elements.- Ingest error handling to properly raise errors when wrapped
- GH issue 1361: fixes a sortig error that prevented some PDF's from being parsed
- Bump unstructured-inference
- Brings back embedded images in PDF's (0.5.23)
- Removed PIL pin as issue has been resolved upstream
- Bump unstructured-inference
- Support for yolox_quantized layout detection model (0.5.20)
- YoloX element types added
- Add Salesforce Connector to be able to pull Account, Case, Campaign, EmailMessage, Lead
- Bump unstructured-inference
- Avoid divide-by-zero errors swith
safe_division
(0.5.21)
- Avoid divide-by-zero errors swith
- Bump unstructured-inference
- Combine entire-page OCR output with layout-detected elements, to ensure full coverage of the page (0.5.19)
- Add in ingest cli s3 writer
- Fix a bug where
xy-cut
sorting attemps to sort elements without valid coordinates; now xy cut sorting only works when all elements have valid coordinates
- Adds
text
as an input parameter topartition_xml
. partition_xml
no longer runs throughpartition_text
, avoiding incorrect splitting on carriage returns in the XML. Sincepartition_xml
no longer callspartition_text
,min_partition
andmax_partition
are no longer supported inpartition_xml
.- Bump
unstructured-inference==0.5.18
, change non-default detectron2 classification threshold - Upgrade base image from rockylinux 8 to rockylinux 9
- Serialize IngestDocs to JSON when passing to subprocesses
- Fix a bug where mismatched
elements
andbboxes
are passed intoadd_pytesseract_bbox_to_elements
- Fix
test_json
to handle only non-extra dependencies file types (plain-text)
- Adds
chunk_by_title
to break a document into sections based on the presence ofTitle
elements. - add new extraction function
extract_image_urls_from_html
to extract all img related URL from html text.
- Make cv2 dependency optional
- Edit
add_pytesseract_bbox_to_elements
's (ocr_only
strategy)metadata.coordinates.points
return type toTuple
for consistency. - Re-enable test-ingest-confluence-diff for ingest tests
- Fix syntax for ingest test check number of files
- Release docker image that installs Python 3.10 rather than 3.8
- Remove overly aggressive ListItem chunking for images and PDF's which typically resulted in inchorent elements.
- Enable
partition_email
andpartition_msg
to detect if an email is PGP encryped. If and email is PGP encryped, the functions will return an empy list of elements and emit a warning about the encrypted content. - Add threaded Slack conversations into Slack connector output
- Add functionality to sort elements using
xy-cut
sorting approach inpartition_pdf
forhi_res
andfast
strategies - Bump unstructured-inference
- Set OMP_THREAD_LIMIT to 1 if not set for better tesseract perf (0.5.17)
- Extract coordinates from PDFs and images when using OCR only strategy and add to metadata
- Update
partition_html
to respect the order of<pre>
tags. - Fix bug in
partition_pdf_or_image
where two partitions were called ifstrategy == "ocr_only"
. - Bump unstructured-inference
- Fix issue where temporary files were being left behind (0.5.16)
- Adds deprecation warning for the
file_filename
kwarg topartition
,partition_via_api
, andpartition_multiple_via_api
. - Fix documentation build workflow by pinning dependencies
- Create new CI Pipelines
- Checking text, xml, email, and html doc tests against the library installed without extras
- Checking each library extra against their respective tests
partition
raises an error and tells the user to install the appropriate extra if a filetype is detected that is missing dependencies.- Add custom errors to ingest
- Bump
unstructured-ingest==0.5.15
- Handle an uncaught TesseractError (0.5.15)
- Add TIFF test file and TIFF filetype to
test_from_image_file
intest_layout
(0.5.14)
- Use
entire_page
ocr mode for pdfs and images - Add notes on extra installs to docs
- Adds ability to reuse connections per process in unstructured-ingest
- Add delta table connector
- Pass ocr_mode in partition_pdf and set the default back to individual pages for now
- Add diagrams and descriptions for ingest design in the ingest README
- Supports multipage TIFF image partitioning
- Bump unstructured-inference==0.5.13:
- Fix extracted image elements being included in layout merge, addresses the issue where an entire-page image in a PDF was not passed to the layout model when using hi_res.
- Bump unstructured-inference==0.5.12:
- fix to avoid trace for certain PDF's (0.5.12)
- better defaults for DPI for hi_res and Chipper (0.5.11)
- implement full-page OCR (0.5.10)
- Fix dead links in repository README (Quick Start > Install for local development, and Learn more > Batch Processing)
- Update document dependencies to include tesseract-lang for additional language support (required for tests to pass)
- Add
include_header
kwarg topartition_xlsx
and change default behavior toTrue
- Update the
links
andemphasized_texts
metadata fields
- Pinned dependency cleanup.
- Update
partition_csv
to always usesoupparser_fromstring
to parsehtml text
- Update
partition_tsv
to always usesoupparser_fromstring
to parsehtml text
- Add
metadata.section
to capture epub table of contents data - Add
unique_element_ids
kwarg to partition functions. IfTrue
, will use a UUID for element IDs instead of a SHA-256 hash. - Update
partition_xlsx
to always usesoupparser_fromstring
to parsehtml text
- Add functionality to switch
html
text parser based on whether thehtml
text contains emoji - Add functionality to check if a string contains any emoji characters
- Add CI tests around Notion
- Add Airtable Connector to be able to pull views/tables/bases from an Airtable organization
- fix pdf partition of list items being detected as titles in OCR only mode
- make notion module discoverable
- fix emails with
Content-Distribution: inline
andContent-Distribution: attachment
with no filename - Fix email attachment filenames which had
=
in the filename itself
- Update table extraction section in API documentation to sync with change in Prod API
- Update Notion connector to extract to html
- Added UUID option for
element_id
- Bump unstructured-inference==0.5.9:
- better caching of models
- another version of detectron2 available, though the default layout model is unchanged
- Added UUID option for element_id
- Added UUID option for element_id
- CI improvements to run ingest tests in parallel
- Adds Sharepoint connector.
- Bump unstructured-inference==0.5.9:
- ignores Tesseract errors where no text is extracted for tiles that indeed, have no text
- Adds --partition-pdf-infer-table-structure to unstructured-ingest.
- Enable
partition_html
to skip headers and footers with theskip_headers_and_footers
flag. - Update
partition_doc
andpartition_docx
to track emphasized texts in the output - Adds post processing function
filter_element_types
- Set the default strategy for partitioning images to
hi_res
- Add page break parameter section in API documentation to sync with change in Prod API
- Update
partition_html
to track emphasized texts in the output - Update
XMLDocument._read_xml
to create<p>
tag element for the text enclosed in the<pre>
tag - Add parameter
include_tail_text
to_construct_text
to enable (skip) tail text inclusion - Add Notion connector
- Remove unused
_partition_via_api
function - Fixed emoji bug in
partition_xlsx
. - Pass
file_filename
metadata when partitioning file object - Skip ingest test on missing Slack token
- Add Dropbox variables to CI environments
- Remove default encoding for ingest
- Adds new element type
EmailAddress
for recognising email address in the text - Simplifies
min_partition
logic; makes partitions falling below themin_partition
less likely. - Fix bug where ingest test check for number of files fails in smoke test
- Fix unstructured-ingest entrypoint failure
- Dependencies are now split by document type, creating a slimmer base installation.
- Rename "date" field to "last_modified"
- Adds Box connector
- Put back useful function
split_by_paragraph
- Fix argument order in NLTK download step
- Remove debug print lines and non-functional code
- Add parameter
skip_infer_table_types
to enable (skip) table extraction for other doc types - Adds optional Unstructured API unit tests in CI
- Tracks last modified date for all document types.
- Add auto_paragraph_grouper to detect new-line and blank-line new paragraph for .txt files.
- refactor the ingest cli to better support expanding supported connectors
- NLTK now only gets downloaded if necessary.
- Handling for empty tables in Word Documents and PowerPoints.
- Additional tests and refactor of JSON detection.
- Update functionality to retrieve image metadata from a page for
document_to_element_list
- Links are now tracked in
partition_html
output. - Set the file's current position to the beginning after reading the file in
convert_to_bytes
- Add
min_partition
kwarg to that combines elements below a specified threshold and modifies splitting of strings longer than max partition so words are not split. - set the file's current position to the beginning after reading the file in
convert_to_bytes
- Add slide notes to pptx
- Add
--encoding
directive to ingest - Improve json detection by
detect_filetype
- Adds Outlook connector
- Add support for dpi parameter in inference library
- Adds Onedrive connector.
- Add Confluence connector for ingest cli to pull the body text from all documents from all spaces in a confluence domain.
- Fixes issue with email partitioning where From field was being assigned the To field value.
- Use the
image_metadata
property of thePageLayout
instance to get the page image info in thedocument_to_element_list
- Add functionality to write images to computer storage temporarily instead of keeping them in memory for
ocr_only
strategy - Add functionality to convert a PDF in small chunks of pages at a time for
ocr_only
strategy - Adds
.txt
,.text
, and.tab
to list of extensions to check if file has atext/plain
MIME type. - Enables filters to be passed to
partition_doc
so it doesn't error with LibreOffice7. - Removed old error message that's superseded by
requires_dependencies
. - Removes using
hi_res
as the default strategy value forpartition_via_api
andpartition_multiple_via_api
- Add support for Python 3.11
- Fixed
auto
strategy detected scanned document as having extractable text and usingfast
strategy, resulting in no output. - Fix list detection in MS Word documents.
- Don't instantiate an element with a coordinate system when there isn't a way to get its location data.
- Allow model used for hi res pdf partition strategy to be chosen when called.
- Updated inference package
- Add
metadata_filename
parameter across all partition functions
-
Update to ensure
convert_to_datafame
grabs all of the metadata fields. -
Adjust encoding recognition threshold value in
detect_file_encoding
-
Fix KeyError when
isd_to_elements
doesn't find a type -
Fix
_output_filename
for local connector, allowing single files to be written correctly to the disk -
Fix for cases where an invalid encoding is extracted from an email header.
- Information about an element's location is no longer returned as top-level attributes of an element. Instead, it is returned in the
coordinates
attribute of the element's metadata.
- Adds
include_metadata
kwarg topartition_doc
,partition_docx
,partition_email
,partition_epub
,partition_json
,partition_msg
,partition_odt
,partition_org
,partition_pdf
,partition_ppt
,partition_pptx
,partition_rst
, andpartition_rtf
- Add Elasticsearch connector for ingest cli to pull specific fields from all documents in an index.
- Adds Dropbox connector
- Fix tests that call unstructured-api by passing through an api-key
- Fixed page breaks being given (incorrect) page numbers
- Fix skipping download on ingest when a source document exists locally
- More deterministic element ordering when using
hi_res
PDF parsing strategy (from unstructured-inference bump to 0.5.4) - Make large model available (from unstructured-inference bump to 0.5.3)
- Combine inferred elements with extracted elements (from unstructured-inference bump to 0.5.2)
partition_email
andpartition_msg
will now process attachments ifprocess_attachments=True
and a attachment partitioning functions is passed through withattachment_partitioner=partition
.
- Fix tests that call unstructured-api by passing through an api-key
- Fixed page breaks being given (incorrect) page numbers
- Fix skipping download on ingest when a source document exists locally
- Adds a
max_partition
parameter topartition_text
,partition_pdf
,partition_email
,partition_msg
andpartition_xml
that sets a limit for the size of an individual document elements. Defaults to1500
for everything exceptpartition_xml
, which has a default value ofNone
. - DRY connector refactor
hi_res
model for pdfs and images is selectable via environment variable.
- CSV check now ignores escaped commas.
- Fix for filetype exploration util when file content does not have a comma.
- Adds negative lookahead to bullet pattern to avoid detecting plain text line
breaks like
-------
as list items. - Fix pre tag parsing for
partition_html
- Fix lookup error for annotated Arabic and Hebrew encodings
- Improvements to string check for leafs in
partition_xml
. - Adds --partition-ocr-languages to unstructured-ingest.
- Adds
partition_org
for processed Org Mode documents.
- Adds Google Cloud Service connector
- Updates the
parse_email
forpartition_eml
so thatunstructured-api
passes the smoke tests partition_email
now works if there is no message content- Updates the
"fast"
strategy forpartition_pdf
so that it's able to recursively - Adds recursive functionality to all fsspec connectors
- Adds generic --recursive ingest flag
- Adds functionality to replace the
MIME
encodings foreml
files with one of the common encodings if aunicode
error occurs - Adds missed file-like object handling in
detect_file_encoding
- Adds functionality to extract charset info from
eml
files
- Added coordinate system class to track coordinate types and convert to different coordinate
- Adds an
html_assemble_articles
kwarg topartition_html
to enable users to capture control whether content outside of<article>
tags is captured when<article>
tags are present. - Check for the
xml
attribute onelement
before looking for pagebreaks inpartition_docx
.
- Convert fast startegy to ocr_only for images
- Adds support for page numbers in
.docx
and.doc
when user or renderer created page breaks are present. - Adds retry logic for the unstructured-ingest Biomed connector
- Provides users with the ability to extract additional metadata via regex.
- Updates
partition_docx
to include headers and footers in the output. - Create
partition_tsv
and associated tests. Make additional changes todetect_filetype
.
- Remove fake api key in test
partition_via_api
since we now require valid/empty api keys - Page number defaults to
None
instead of1
when page number is not present in the metadata. A page number ofNone
indicates that page numbers are not being tracked for the document or that page numbers do not apply to the element in question.. - Fixes an issue with some pptx files. Assume pptx shapes are found in top left position of slide
in case the shape.top and shape.left attributes are
None
.
- Adds functionality to sort elements in
partition_pdf
forfast
strategy - Adds ingest tests with
--fast
strategy on PDF documents - Adds --api-key to unstructured-ingest
- Adds
partition_rst
for processed ReStructured Text documents.
- Adds handling for emails that do not have a datetime to extract.
- Adds pdf2image package as core requirement of unstructured (with no extras)
- Allows passing kwargs to request data field for
partition_via_api
andpartition_multiple_via_api
- Enable MIME type detection if libmagic is not available
- Adds handling for empty files in
detect_filetype
andpartition
.
- Reslove
grpcio
import issue onweaviate.schema.validate_schema
for python 3.9 and 3.10 - Remove building
detectron2
from source in Dockerfile
- Update IngestDoc abstractions and add data source metadata in ElementMetadata
- Pass
strategy
parameter down frompartition
forpartition_image
- Filetype detection if a CSV has a
text/plain
MIME type convert_office_doc
no longers prints file conversion info messages to stdout.partition_via_api
reflects the actual filetype for the file processed in the API.
- Adds an optional encoding kwarg to
elements_to_json
andelements_from_json
- Bump version of base image to use new stable version of tesseract
- Update the
read_txt_file
utility function to keep usingspooled_to_bytes_io_if_needed
for xml - Add functionality to the
read_txt_file
utility function to handle file-like object from URL - Remove the unused parameter
encoding
frompartition_pdf
- Change auto.py to have a
None
default for encoding - Add functionality to try other common encodings for html and xml files if an error related to the encoding is raised and the user has not specified an encoding.
- Adds benchmark test with test docs in example-docs
- Re-enable test_upload_label_studio_data_with_sdk
- File detection now detects code files as plain text
- Adds
tabulate
explicitly to dependencies - Fixes an issue in
metadata.page_number
of pptx files - Adds showing help if no parameters passed
- Add
stage_for_weaviate
to stageunstructured
outputs for upload to Weaviate, along with a helper function for defining a class to use in Weaviate schemas. - Builds from Unstructured base image, built off of Rocky Linux 8.7, this resolves almost all CVE's in the image.
- Installing
detectron2
from source is no longer required when using thelocal-inference
extra. - Updates
.pptx
parsing to include text in tables.
- Fixes an issue in
_add_element_metadata
that caused all elements to havepage_number=1
in the element metadata. - Adds
.log
as a file extension for TXT files. - Adds functionality to try other common encodings for email (
.eml
) files if an error related to the encoding is raised and the user has not specified an encoding. - Allow passed encoding to be used in the
replace_mime_encodings
- Fixes page metadata for
partition_html
wheninclude_metadata=False
- A
ValueError
now raises iffile_filename
is not specified when you usepartition_via_api
with a file-like object.
- Supports epub tests since pandoc is updated in base image
- XLS support from auto partition
- fast strategy for pdf now keeps element bounding box data
- setup.py refactor
- Adds functionality to try other common encodings if an error related to the encoding is raised and the user has not specified an encoding.
- Adds additional MIME types for CSV
- Add
partition_csv
for CSV files.
- Deprecate
--s3-url
in favor of--remote-url
in CLI - Refactor out non-connector-specific config variables
- Add
file_directory
to metadata - Add
page_name
to metadata. Currently used for the sheet name in XLSX documents. - Added a
--partition-strategy
parameter to unstructured-ingest so that users can specify partition strategy in CLI. For example,--partition-strategy fast
. - Added metadata for filetype.
- Add Discord connector to pull messages from a list of channels
- Refactor
unstructured/file-utils/filetype.py
to better utilise hashmap to return mime type. - Add local declaration of DOCX_MIME_TYPES and XLSX_MIME_TYPES for
test_filetype.py
.
- Add
partition_xml
for XML files. - Add
partition_xlsx
for Microsoft Excel documents.
- Supports
hml
filetype for partition as a variation of html filetype. - Makes
pytesseract
a function level import inpartition_pdf
so you can use the"fast"
or"hi_res"
strategies ifpytesseract
is not installed. Also adds therequired_dependencies
decorator for the"hi_res"
and"ocr_only"
strategies. - Fix to ensure
filename
is tracked in metadata fordocx
tables.
- Adds an
"auto"
strategy that chooses the partitioning strategy based on document characteristics and function kwargs. This is the new default strategy forpartition_pdf
andpartition_image
. Users can maintain existing behavior by explicitly settingstrategy="hi_res"
. - Added an additional trace logger for NLP debugging.
- Add
get_date
method toElementMetadata
for converting the datestring to adatetime
object. - Cleanup the
filename
attribute onElementMetadata
to remove the full filepath.
- Added table reading as html with URL parsing to
partition_docx
in docx - Added metadata field for text_as_html for docx files
fileutils/file_type
check json and eml decode ignore errorpartition_email
was updated to more flexibly handle deviations from the RFC-2822 standard. The time in the metadata returnsNone
if the time does not match RFC-2822 at all.- Include all metadata fields when converting to dataframe or CSV
- Added support for SpooledTemporaryFile file argument.
- Added an "ocr_only" strategy for
partition_pdf
. Refactored the strategy decision logic into its own module.
- Add an "ocr_only" strategy for
partition_image
.
- Added
partition_multiple_via_api
for partitioning multiple documents in a single REST API call. - Added
stage_for_baseplate
function to prepare outputs for ingestion into Baseplate. - Added
partition_odt
for processing Open Office documents.
- Updates the grouping logic in the
partition_pdf
fast strategy to group together text in the same bounding box.
- Added logic to
partition_pdf
for detecting copy protected PDFs and falling back to the hi res strategy when necessary.
- Add
partition_via_api
for partitioning documents through the hosted API.
- Fix how
exceeds_cap_ratio
handles empty (returnsTrue
instead ofFalse
) - Updates
detect_filetype
to properly detect JSONs when the MIME type istext/plain
.
- Updated the table extraction parameter name to be more descriptive
- Adds an
ssl_verify
kwarg topartition
andpartition_html
to enable turning off SSL verification for HTTP requests. SSL verification is on by default. - Allows users to pass in ocr language to
partition_pdf
andpartition_image
through theocr_language
kwarg.ocr_language
corresponds to the code for the language pack in Tesseract. You will need to install the relevant Tesseract language pack to use a given language.
- Table extraction is now possible for pdfs from
partition
andpartition_pdf
. - Adds support for extracting attachments from
.msg
files
- Adds an
ssl_verify
kwarg topartition
andpartition_html
to enable turning off SSL verification for HTTP requests. SSL verification is on by default.
- Allow headers to be passed into
partition
whenurl
is used.
bytes_string_to_string
cleaning brick for bytes string output.
- Fixed typo in call to
exactly_one
inpartition_json
- unstructured-documents encode xml string if document_tree is
None
in_read_xml
. - Update to
_read_xml
so that Markdown files with embedded HTML process correctly. - Fallback to "fast" strategy only emits a warning if the user specifies the "hi_res" strategy.
- unstructured-partition-text_type exceeds_cap_ratio fix returns and how capitalization ratios are calculated
partition_pdf
andpartition_text
group broken paragraphs to avoid fragmentedNarrativeText
elements.- .json files resolved as "application/json" on centos7 (or other installs with older libmagic libs)
- Add OS mimetypes DB to docker image, mainly for unstructured-api compat.
- Use the image registry as a cache when building Docker images.
- Adds the ability for
partition_text
to group together broken paragraphs. - Added method to utils to allow date time format validation
-
Add Slack connector to pull messages for a specific channel
-
Add --partition-by-api parameter to unstructured-ingest
-
Added
partition_rtf
for processing rich text files. -
partition
now accepts aurl
kwarg in addition tofile
andfilename
.
- Allow encoding to be passed into
replace_mime_encodings
. - unstructured-ingest connector-specific dependencies are imported on demand.
- unstructured-ingest --flatten-metadata supported for local connector.
- unstructured-ingest fix runtime error when using --metadata-include.
- Guard against null style attribute in docx document elements
- Update HTML encoding to better support foreign language characters
- Updated inference package
- Add sender, recipient, date, and subject to element metadata for emails
- Added
--download-only
parameter tounstructured-ingest
- FileNotFound error when filename is provided but file is not on disk
- Convert file to str in helper
split_by_paragraph
forpartition_text
- Update
elements_to_json
to return string when filename is not specified elements_from_json
may take a string instead of a filename with thetext
kwargdetect_filetype
now does a final fallback to file extension.- Empty tags are now skipped during the depth check for HTML processing.
- Add local file system to
unstructured-ingest
- Add
--max-docs
parameter tounstructured-ingest
- Added
partition_msg
for processing MSFT Outlook .msg files.
convert_file_to_text
now passes through thesource_format
andtarget_format
kwargs. Previously they were hard coded.- Partitioning functions that accept a
text
kwarg no longer raise an error if an empty string is passed (and empty list of elements is returned instead). partition_json
no longer fails if the input is an empty list.- Fixed bug in
chunk_by_attention_window
that caused the last word in segments to be cut-off in some cases.
stage_for_transformers
now returns a list of elements, making it consistent with other staging bricks
- Refactored codebase using
exactly_one
- Adds ability to pass headers when passing a url in partition_html()
- Added optional
content_type
andfile_filename
parameters topartition()
to bypass file detection
- Add
--flatten-metadata
parameter tounstructured-ingest
- Add
--fields-include
parameter tounstructured-ingest
contains_english_word()
, used heavily in text processing, is 10x faster.
- Add
--metadata-include
and--metadata-exclude
parameters tounstructured-ingest
- Add
clean_non_ascii_chars
to remove non-ascii characters from unicode string
- Fix problem with PDF partition (duplicated test)
- Added Biomedical literature connector for ingest cli.
- Add
FsspecConnector
to easily integrate any existingfsspec
filesystem as a connector. - Rename
s3_connector.py
tos3.py
for readability and consistency with the rest of the connectors. - Now
S3Connector
relies ons3fs
instead of onboto3
, and it inherits fromFsspecConnector
. - Adds an
UNSTRUCTURED_LANGUAGE_CHECKS
environment variable to control whether or not language specific checks like vocabulary and POS tagging are applied. Set to"true"
for higher resolution partitioning and"false"
for faster processing. - Improves
detect_filetype
warning to include filename when provided. - Adds a "fast" strategy for partitioning PDFs with PDFMiner. Also falls back to the "fast" strategy if detectron2 is not available.
- Start deprecation life cycle for
unstructured-ingest --s3-url
option, to be deprecated in favor of--remote-url
.
- Add
AzureBlobStorageConnector
based on itsfsspec
implementation inheriting fromFsspecConnector
- Add
partition_epub
for partitioning e-books in EPUB3 format.
- Fixes processing for text files with
message/rfc822
MIME type. - Open xml files in read-only mode when reading contents to construct an XMLDocument.
auto.partition()
can now load Unstructured ISD json documents.- Simplify partitioning functions.
- Improve logging for ingest CLI.
- Add
--wikipedia-auto-suggest
argument to the ingest CLI to disable automatic redirection to pages with similar names. - Add setup script for Amazon Linux 2
- Add optional
encoding
argument to thepartition_(text/email/html)
functions. - Added Google Drive connector for ingest cli.
- Added Gitlab connector for ingest cli.
- Fully move from printing to logging.
unstructured-ingest
now uses a default--download_dir
of$HOME/.cache/unstructured/ingest
rather than a "tmp-ingest-" dir in the working directory.
setup_ubuntu.sh
no longer fails in some contexts by interpretingDEBIAN_FRONTEND=noninteractive
as a commandunstructured-ingest
no longer re-downloads files when --preserve-downloads is used without --download-dir.- Fixed an issue that was causing text to be skipped in some HTML documents.
- Fixes an error causing JavaScript to appear in the output of
partition_html
sometimes. - Fix several issues with the
requires_dependencies
decorator, including the error message and how it was used, which had caused an error forunstructured-ingest --github-url ...
.
- Add
requires_dependencies
Python decorator to check dependencies are installed before instantiating a class or running a function
- Added Wikipedia connector for ingest cli.
- Fix
process_document
file cleaning on failure - Fixes an error introduced in the metadata tracking commit that caused
NarrativeText
andFigureCaption
elements to be represented asText
in HTML documents.
- Fallback to using file extensions for filetype detection if
libmagic
is not present
- Added setup script for Ubuntu
- Added GitHub connector for ingest cli.
- Added
partition_md
partitioner. - Added Reddit connector for ingest cli.
- Initializes connector properly in ingest.main::MainProcess
- Restricts version of unstructured-inference to avoid multithreading issue
- Added
elements_to_json
andelements_from_json
for easier serialization/deserialization convert_to_dict
,dict_to_elements
andconvert_to_csv
are now aliases for functions that use the ISD terminology.
- Update to ensure all elements are preserved during serialization/deserialization
- Automatically install
nltk
models in thetokenize
module.
- Fixes unstructured-ingest cli.
- Adds console_entrypoint for unstructured-ingest, other structure/doc updates related to ingest.
- Add
parser
parameter topartition_html
.
- Adds
partition_doc
for partitioning Word documents in.doc
format. Requireslibreoffice
. - Adds
partition_ppt
for partitioning PowerPoint documents in.ppt
format. Requireslibreoffice
.
- Fixes
ElementMetadata
so that it's JSON serializable when the filename is aPath
object.
- Added ingest modules and s3 connector, sample ingest script
- Default to
url=None
forpartition_pdf
andpartition_image
- Add ability to skip English specific check by setting the
UNSTRUCTURED_LANGUAGE
env var to""
. - Document
Element
objects now track metadata
- Modified XML and HTML parsers not to load comments.
- Added the ability to pull an HTML document from a url in
partition_html
. - Added the the ability to get file summary info from lists of filenames and lists of file contents.
- Added optional page break to
partition
for.pptx
,.pdf
, images, and.html
files. - Added
to_dict
method to document elements. - Include more unicode quotes in
replace_unicode_quotes
.
- Loosen the default cap threshold to
0.5
. - Add a
UNSTRUCTURED_NARRATIVE_TEXT_CAP_THRESHOLD
environment variable for controlling the cap ratio threshold. - Unknown text elements are identified as
Text
for HTML and plain text documents. Body Text
styles no longer default toNarrativeText
for Word documents. The style information is insufficient to determine that the text is narrative.- Upper cased text is lower cased before checking for verbs. This helps avoid some missed verbs.
- Adds an
Address
element for capturing elements that only contain an address. - Suppress the
UserWarning
when detectron is called. - Checks that titles and narrative test have at least one English word.
- Checks that titles and narrative text are at least 50% alpha characters.
- Restricts titles to a maximum word length. Adds a
UNSTRUCTURED_TITLE_MAX_WORD_LENGTH
environment variable for controlling the max number of words in a title. - Updated
partition_pptx
to order the elements on the page
- Updated
partition_pdf
andpartition_image
to returnunstructured
Element
objects - Fixed the healthcheck url path when partitioning images and PDFs via API
- Adds an optional
coordinates
attribute to document objects - Adds
FigureCaption
andCheckBox
document elements - Added ability to split lists detected in
LayoutElement
objects - Adds
partition_pptx
for partitioning PowerPoint documents - LayoutParser models now download from HugginfaceHub instead of DropBox
- Fixed file type detection for XML and HTML files on Amazone Linux
- Adds
requests
as a base dependency - Fix in
exceeds_cap_ratio
so the function doesn't break with empty text - Fix bug in
_parse_received_data
. - Update
detect_filetype
to properly handle.doc
,.xls
, and.ppt
.
- Added
partition_image
to process documents in an image format. - Fixed utf-8 encoding error in
partition_email
with attachments fortext/html
- Added support for text files in the
partition
function - Pinned
opencv-python
for easier installation on Linux
- Added generic
partition
brick that detects the file type and routes a file to the appropriate partitioning brick. - Added a file type detection module.
- Updated
partition_html
andpartition_eml
to support file-like objects in 'rb' mode. - Cleaning brick for removing ordered bullets
clean_ordered_bullets
. - Extract brick method for ordered bullets
extract_ordered_bullets
. - Test for
clean_ordered_bullets
. - Test for
extract_ordered_bullets
. - Added
partition_docx
for pre-processing Word Documents. - Added new REGEX patterns to extract email header information
- Added new functions to extract header information
parse_received_data
andpartition_header
- Added new function to parse plain text files
partition_text
- Added new cleaners functions
extract_ip_address
,extract_ip_address_name
,extract_mapi_id
,extract_datetimetz
- Add new
Image
element and function to find embedded imagesfind_embedded_images
- Added
get_directory_file_info
for summarizing information about source documents
- Add support for local inference
- Add new pattern to recognize plain text dash bullets
- Add test for bullet patterns
- Fix for
partition_html
that allows for processingdiv
tags that have both text and child elements - Add ability to extract document metadata from
.docx
,.xlsx
, and.jpg
files. - Helper functions for identifying and extracting phone numbers
- Add new function
extract_attachment_info
that extracts and decodes the attachment of an email. - Staging brick to convert a list of
Element
s to apandas
dataframe. - Add plain text functionality to
partition_email
- Python-3.7 compat
- Removes BasicConfig from logger configuration
- Adds the
partition_email
partitioning brick - Adds the
replace_mime_encodings
cleaning bricks - Small fix to HTML parsing related to processing list items with sub-tags
- Add
EmailElement
data structure to store email documents
- Added
translate_text
brick for translating text between languages - Add an
apply
method to make it easier to apply cleaners to elements
- Added __init.py__ to
partition
- Implement staging brick for Argilla. Converts lists of
Text
elements toargilla
dataset classes. - Removing the local PDF parsing code and any dependencies and tests.
- Reorganizes the staging bricks in the unstructured.partition module
- Allow entities to be passed into the Datasaur staging brick
- Added HTML escapes to the
replace_unicode_quotes
brick - Fix bad responses in partition_pdf to raise ValueError
- Adds
partition_html
for partitioning HTML documents.
- Small change to how _read is placed within the inheritance structure since it doesn't really apply to pdf
- Add partitioning brick for calling the document image analysis API
- Update python requirement to >=3.7
- Add alternative way of importing
Final
to support google colab
- Add cleaning bricks for removing prefixes and postfixes
- Add cleaning bricks for extracting text before and after a pattern
- Add staging brick for Datasaur
- Added brick to convert an ISD dictionary to a list of elements
- Update
PDFDocument
to use thefrom_file
method - Added staging brick for CSV format for ISD (Initial Structured Data) format.
- Added staging brick for separating text into attention window size chunks for
transformers
. - Added staging brick for LabelBox.
- Added ability to upload LabelStudio predictions
- Added utility function for JSONL reading and writing
- Added staging brick for CSV format for Prodigy
- Added staging brick for Prodigy
- Added ability to upload LabelStudio annotations
- Added text_field and id_field to stage_for_label_studio signature
- Initial release of unstructured