unstructured/CHANGELOG.md

0.10.29-dev2

Enhancements

• Add include_header argument for partition_csv and partition_tsv Now supports retaining header rows in CSV and TSV documents element partitioning.
• Add retry logic for all source connectors All http calls being made by the ingest source connectors have been isolated and wrapped by the SourceConnectionNetworkError custom error, which triggers the retry logic, if enabled, in the ingest pipeline.

Features

Fixes

• Ingest session handler not being shared correctly All ingest docs that leverage the session handler should only need to set it once per process. It was recreating it each time because the right values weren't being set nor available given how dataclasses work in python.
• Ingest download-only fix Previously the download only flag was being checked after the doc factory pipeline step, which occurs before the files are actually downloaded by the source node. This check was moved after the source node to allow for the files to be downloaded first before exiting the pipeline.

0.10.28

Enhancements

• Add element type CI evaluation workflow Adds element type frequency evaluation metrics to the current ingest workflow to measure the performance of each file extracted as well as aggregated-level performance.
• Add table structure evaluation helpers Adds functions to evaluate the similarity between predicted table structure and actual table structure.
• Use yolox by default for table extraction when partitioning pdf/image yolox model provides higher recall of the table regions than the quantized version and it is now the default element detection model when infer_table_structure=True for partitioning pdf/image files
• Remove pdfminer elements from inside tables Previously, when using hi_res some elements where extracted using pdfminer too, so we removed pdfminer from the tables pipeline to avoid duplicated elements.
• Fsspec downstream connectors New destination connector added to ingest CLI, users may now use unstructured-ingest to write to any of the following:
  • Azure
  • Box
  • Dropbox
  • Google Cloud Service

Features

• Update ocr_only strategy in partition_pdf() Adds the functionality to get accurate coordinate data when partitioning PDFs and Images with the ocr_only strategy.

Fixes

• Fixes issue where tables from markdown documents were being treated as text Problem: Tables from markdown documents were being treated as text, and not being extracted as tables. Solution: Enable the tables extension when instantiating the python-markdown object. Importance: This will allow users to extract structured data from tables in markdown documents.
• Fix wrong logger for paddle info Replace the logger from unstructured-inference with the logger from unstructured for paddle_ocr.py module.
• Fix ingest pipeline to be able to use chunking and embedding together Problem: When ingest pipeline was using chunking and embedding together, embedding outputs were empty and the outputs of chunking couldn't be re-read into memory and be forwarded to embeddings. Fix: Added CompositeElement type to TYPE_TO_TEXT_ELEMENT_MAP to be able to process CompositeElements with unstructured.staging.base.isd_to_elements
• Fix unnecessary mid-text chunk-splitting. The "pre-chunker" did not consider separator blank-line ("\n\n") length when grouping elements for a single chunk. As a result, sections were frequently over-populated producing a over-sized chunk that required mid-text splitting.
• Fix frequent dissociation of title from chunk. The sectioning algorithm included the title of the next section with the prior section whenever it would fit, frequently producing association of a section title with the prior section and dissociating it from its actual section. Fix this by performing combination of whole sections only.
• Fix PDF attempt to get dict value from string. Fixes a rare edge case that prevented some PDF's from being partitioned. The get_uris_from_annots function tried to access the dictionary value of a string instance variable. Assign None to the annotation variable if the instance type is not dictionary to avoid the erroneous attempt.

0.10.27

Enhancements

• Leverage dict to share content across ingest pipeline To share the ingest doc content across steps in the ingest pipeline, this was updated to use a multiprocessing-safe dictionary so changes get persisted and each step has the option to modify the ingest docs in place.

Features

Fixes

• Removed ebooklib as a dependency ebooklib is licensed under AGPL3, which is incompatible with the Apache 2.0 license. Thus it is being removed.
• Caching fixes in ingest pipeline Previously, steps like the source node were not leveraging parameters such as re_download to dictate if files should be forced to redownload rather than use what might already exist locally.

0.10.26

Enhancements

• Add CI evaluation workflow Adds evaluation metrics to the current ingest workflow to measure the performance of each file extracted as well as aggregated-level performance.

Features

• Functionality to catch and classify overlapping/nested elements Method to identify overlapping-bboxes cases within detected elements in a document. It returns two values: a boolean defining if there are overlapping elements present, and a list reporting them with relevant metadata. The output includes information about the overlapping_elements, overlapping_case, overlapping_percentage, largest_ngram_percentage, overlap_percentage_total, max_area, min_area, and total_area.
• Add Local connector source metadata python's os module used to pull stats from local file when processing via the local connector and populates fields such as last modified time, created time.

Fixes

• Fixes elements partitioned from an image file missing certain metadata Metadata for image files, like file type, was being handled differently from other file types. This caused a bug where other metadata, like the file name, was being missed. This change brought metadata handling for image files to be more in line with the handling for other file types so that file name and other metadata fields are being captured.
• Adds typing-extensions as an explicit dependency This package is an implicit dependency, but the module is being imported directly in unstructured.documents.elements so the dependency should be explicit in case changes in other dependencies lead to typing-extensions being dropped as a dependency.
• Stop passing extract_tables to unstructured-inference since it is now supported in unstructured instead Table extraction previously occurred in unstructured-inference, but that logic, except for the table model itself, is now a part of the unstructured library. Thus the parameter triggering table extraction is no longer passed to the unstructured-inference package. Also noted the table output regression for PDF files.
• Fix a bug in Table partitioning Previously the skip_infer_table_types variable used in partition was not being passed down to specific file partitioners. Now you can utilize the skip_infer_table_types list variable when calling partition to specify the filetypes for which you want to skip table extraction, or the infer_table_structure boolean variable on the file specific partitioning function.
• Fix partition docx without sections Some docx files, like those from teams output, do not contain sections and it would produce no results because the code assumes all components are in sections. Now if no sections is detected from a document we iterate through the paragraphs and return contents found in the paragraphs.
• Fix out-of-order sequencing of split chunks. Fixes behavior where "split" chunks were inserted at the beginning of the chunk sequence. This would produce a chunk sequence like [5a, 5b, 3a, 3b, 1, 2, 4] when sections 3 and 5 exceeded max_characters.
• Deserialization of ingest docs fixed When ingest docs are being deserialized as part of the ingest pipeline process (cli), there were certain fields that weren't getting persisted (metadata and date processed). The from_dict method was updated to take these into account and a unit test added to check.
• Map source cli command configs when destination set Due to how the source connector is dynamically called when the destination connector is set via the CLI, the configs were being set incorrectoy, causing the source connector to break. The configs were fixed and updated to take into account Fsspec-specific connectors.

0.10.25

Enhancements

• Duplicate CLI param check Given that many of the options associated with the Click based cli ingest commands are added dynamically from a number of configs, a check was incorporated to make sure there were no duplicate entries to prevent new configs from overwriting already added options.
• Ingest CLI refactor for better code reuse Much of the ingest cli code can be templated and was a copy-paste across files, adding potential risk. Code was refactored to use a base class which had much of the shared code templated.

Features

• Table OCR refactor support Table OCR with pre-computed OCR data to ensure we only do one OCR for entrie document. User can specify ocr agent tesseract/paddle in environment variable OCR_AGENT for OCRing the entire document.
• Adds accuracy function The accuracy scoring was originally an option under calculate_edit_distance. For easy function call, it is now a wrapper around the original function that calls edit_distance and return as "score".
• Adds HuggingFaceEmbeddingEncoder The HuggingFace Embedding Encoder uses a local embedding model as opposed to using an API.
• Add AWS bedrock embedding connector unstructured.embed.bedrock now provides a connector to use AWS bedrock's titan-embed-text model to generate embeddings for elements. This features requires valid AWS bedrock setup and an internet connectionto run.

Fixes

• Import PDFResourceManager more directly We were importing PDFResourceManager from pdfminer.converter which was causing an error for some users. We changed to import from the actual location of PDFResourceManager, which is pdfminer.pdfinterp.
• Fix language detection of elements with empty strings This resolves a warning message that was raised by langdetect if the language was attempted to be detected on an empty string. Language detection is now skipped for empty strings.
• Fix chunks breaking on regex-metadata matches. Fixes "over-chunking" when regex_metadata was used, where every element that contained a regex-match would start a new chunk.
• Fix regex-metadata match offsets not adjusted within chunk. Fixes incorrect regex-metadata match start/stop offset in chunks where multiple elements are combined.
• Map source cli command configs when destination set Due to how the source connector is dynamically called when the destination connector is set via the CLI, the configs were being set incorrectoy, causing the source connector to break. The configs were fixed and updated to take into account Fsspec-specific connectors.
• Fix metrics folder not discoverable Fixes issue where unstructured/metrics folder is not discoverable on PyPI by adding an __init__.py file under the folder.
• Fix a bug when parition_pdf get model_name=None In API usage the model_name value is None and the cast function in partition_pdf would return None and lead to attribution error. Now we use str function to explicit convert the content to string so it is garanteed to have starts_with and other string functions as attributes
• Fix html partition fail on tables without tbody tag HTML tables may sometimes just contain headers without body (tbody tag)

0.10.24

Enhancements

• Improve natural reading order Some OCR elements with only spaces in the text have full-page width in the bounding box, which causes the xycut sorting to not work as expected. Now the logic to parse OCR results removes any elements with only spaces (more than one space).
• Ingest compression utilities and fsspec connector support Generic utility code added to handle files that get pulled from a source connector that are either tar or zip compressed and uncompress them locally. This is then processed using a local source connector. Currently this functionality has been incorporated into the fsspec connector and all those inheriting from it (currently: Azure Blob Storage, Google Cloud Storage, S3, Box, and Dropbox).
• Ingest destination connectors support for writing raw list of elements Along with the default write method used in the ingest pipeline to write the json content associated with the ingest docs, each destination connector can now also write a raw list of elements to the desired downstream location without having an ingest doc associated with it.

Features

• Adds element type percent match function In order to evaluate the element type extracted, we add a function that calculates the matched percentage between two frequency dictionary.

Fixes

• Fix paddle model file not discoverable Fixes issue where ocr_models/paddle_ocr.py file is not discoverable on PyPI by adding an __init__.py file under the folder.
• Chipper v2 Fixes Includes fix for a memory leak and rare last-element bbox fix. (unstructured-inference==0.7.7)
• Fix image resizing issue Includes fix related to resizing images in the tables pipeline. (unstructured-inference==0.7.6)

0.10.23

Enhancements

• Add functionality to limit precision when serializing to json Precision for points is limited to 1 decimal point if coordinates["system"] == "PixelSpace" (otherwise 2 decimal points?). Precision for detection_class_prob is limited to 5 decimal points.
• Fix csv file detection logic when mime-type is text/plain Previously the logic to detect csv file type was considering only first row's comma count comparing with the header_row comma count and both the rows being same line the result was always true, Now the logic is changed to consider the comma's count for all the lines except first line and compare with header_row comma count.
• Improved inference speed for Chipper V2 API requests with 'hi_res_model_name=chipper' now have ~2-3x faster responses.

Features

Fixes

• Cleans up temporary files after conversion Previously a file conversion utility was leaving temporary files behind on the filesystem without removing them when no longer needed. This fix helps prevent an accumulation of temporary files taking up excessive disk space.
• Fixes under_non_alpha_ratio dividing by zero Although this function guarded against a specific cause of division by zero, there were edge cases slipping through like strings with only whitespace. This update more generally prevents the function from performing a division by zero.
• Fix languages default Previously the default language was being set to English when elements didn't have text or if langdetect could not detect the language. It now defaults to None so there is not misleading information about the language detected.
• Fixes recursion limit error that was being raised when partitioning Excel documents of a certain size Previously we used a recursive method to find subtables within an excel sheet. However this would run afoul of Python's recursion depth limit when there was a contiguous block of more than 1000 cells within a sheet. This function has been updated to use the NetworkX library which avoids Python recursion issues.

0.10.22

Enhancements

• bump unstructured-inference to 0.7.3 The updated version of unstructured-inference supports a new version of the Chipper model, as well as a cleaner schema for its output classes. Support is included for new inference features such as hierarchy and ordering.
• Expose skip_infer_table_types in ingest CLI. For each connector a new --skip-infer-table-types parameter was added to map to the skip_infer_table_types partition argument. This gives more granular control to unstructured-ingest users, allowing them to specify the file types for which we should attempt table extraction.
• Add flag to ingest CLI to raise error if any single doc fails in pipeline Currently if a single doc fails in the pipeline, the whole thing halts due to the error. This flag defaults to log an error but continue with the docs it can.
• Emit hyperlink metadata for DOCX file-type. DOCX partitioner now adds metadata.links, metadata.link_texts and metadata.link_urls for elements that contain a hyperlink that points to an external resource. So-called "jump" links pointing to document internal locations (such as those found in a table-of-contents "jumping" to a chapter or section) are excluded.

Features

• Add elements_to_text as a staging helper function In order to get a single clean text output from unstructured for metric calculations, automate the process of extracting text from elements using this function.
• Adds permissions(RBAC) data ingestion functionality for the Sharepoint connector. Problem: Role based access control is an important component in many data storage systems. Users may need to pass permissions (RBAC) data to downstream systems when ingesting data. Feature: Added permissions data ingestion functionality to the Sharepoint connector.

Fixes

• Fixes PDF list parsing creating duplicate list items Previously a bug in PDF list item parsing caused removal of other elements and duplication of the list item
• Fixes duplicated elements Fixes issue where elements are duplicated when embeddings are generated. This will allow users to generate embeddings for their list of Elements without duplicating/breaking the orginal content.
• Fixes failure when flagging for embeddings through unstructured-ingest Currently adding the embedding parameter to any connector results in a failure on the copy stage. This is resolves the issue by adding the IngestDoc to the context map in the embedding node's run method. This allows users to specify that connectors fetch embeddings without failure.
• Fix ingest pipeline reformat nodes not discoverable Fixes issue where reformat nodes raise ModuleNotFoundError on import. This was due to the directory was missing __init__.py in order to make it discoverable.
• Fix default language in ingest CLI Previously the default was being set to english which injected potentially incorrect information to downstream language detection libraries. By setting the default to None allows those libraries to better detect what language the text is in the doc being processed.

0.10.21

• Adds Scarf analytics.

0.10.20

Enhancements

• Add document level language detection functionality. Adds the "auto" default for the languages param to all partitioners. The primary language present in the document is detected using the langdetect package. Additional param detect_language_per_element is also added for partitioners that return multiple elements. Defaults to False.
• Refactor OCR code The OCR code for entire page is moved from unstructured-inference to unstructured. On top of continuing support for OCR language parameter, we also support two OCR processing modes, "entire_page" or "individual_blocks".
• Align to top left when shrinking bounding boxes for xy-cut sorting: Update shrink_bbox() to keep top left rather than center.
• Add visualization script to annotate elements This script is often used to analyze/visualize elements with coordinates (e.g. partition_pdf()).
• Adds data source properties to the Jira, Github and Gitlab 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.
• Improve title detection in pptx documents The default title textboxes on a pptx slide are now categorized as titles.
• Improve hierarchy detection in pptx documents List items, and other slide text are properly nested under the slide title. This will enable better chunking of pptx documents.
• Refactor of the ingest cli workflow The refactored approach uses a dynamically set pipeline with a snapshot along each step to save progress and accommodate continuation from a snapshot if an error occurs. This also allows the pipeline to dynamically assign any number of steps to modify the partitioned content before it gets written to a destination.
• Applies max_characters=<n> argument to all element types in add_chunking_strategy decorator Previously this argument was only utilized in chunking Table elements and now applies to all partitioned elements if add_chunking_strategy decorator is utilized, further preparing the elements for downstream processing.
• Add common retry strategy utilities for unstructured-ingest Dynamic retry strategy with exponential backoff added to Notion source connector.

Features

• Adds bag_of_words and percent_missing_text functions In order to count the word frequencies in two input texts and calculate the percentage of text missing relative to the source document.
• Adds edit_distance calculation metrics In order to benchmark the cleaned, extracted text with unstructured, edit_distance (Levenshtein distance) is included.
• Adds detection_origin field to metadata Problem: Currently isn't an easy way to find out how an element was created. With this change that information is added. Importance: With this information the developers and users are now able to know how an element was created to make decisions on how to use it. In order tu use this feature setting UNSTRUCTURED_INCLUDE_DEBUG_METADATA=true is needed.
• Adds a function that calculates frequency of the element type and its depth To capture the accuracy of element type extraction, this function counts the occurrences of each unique element type with its depth for use in element metrics.

Fixes

• Fix zero division error in annotation bbox size This fixes the bug where we find annotation bboxes realted to an element that need to divide the intersection size between annotation bbox and element bbox by the size of the annotation bbox
• Fix prevent metadata module from importing dependencies from unnecessary modules Problem: The metadata module had several top level imports that were only used in and applicable to code related to specific document types, while there were many general-purpose functions. As a result, general-purpose functions couldn't be used without unnecessary dependencies being installed. Fix: moved 3rd party dependency top level imports to inside the functions in which they are used and applied a decorator to check that the dependency is installed and emit a helpful error message if not.
• Fixes category_depth None value for Title elements Problem: Title elements from chipper get category_depth= None even when Headline and/or Subheadline elements are present in the same page. Fix: all Title elements with category_depth = None should be set to have a depth of 0 instead iff there are Headline and/or Subheadline element-types present. Importance: Title elements should be equivalent html H1 when nested headings are present; otherwise, category_depth metadata can result ambiguous within elements in a page.
• Tweak xy-cut ordering output to be more column friendly This results in the order of elements more closely reflecting natural reading order which benefits downstream applications. While element ordering from xy-cut is usually mostly correct when ordering multi-column documents, sometimes elements from a RHS column will appear before elements in a LHS column. Fix: add swapped xy-cut ordering by sorting by X coordinate first and then Y coordinate.
• 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 pdf uri error An error was encountered when URI type of GoToR which refers to pdf resources outside of its own was detected since no condition catches such case. The code is fixing the issue by initialize URI before any condition check.

0.10.19

Enhancements

• Adds XLSX document level language detection Enhancing on top of language detection functionality in previous release, we now support language detection within .xlsx file type at Element level.
• bump unstructured-inference to 0.6.6 The updated version of unstructured-inference makes table extraction in hi_res mode configurable to fine tune table extraction performance; it also improves element detection by adding a deduplication post processing step in the hi_res partitioning of pdfs and images.
• Detect text in HTML Heading Tags as Titles This will increase the accuracy of hierarchies in HTML documents and provide more accurate element categorization. If text is in an HTML heading tag and is not a list item, address, or narrative text, categorize it as a title.
• 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 Table support for the add_chunking_strategy decorator to partition functions. In addition to combining elements under Title elements, user's can now specify the max_characters=<n> argument to chunk Table elements into TableChunk elements with text and text_as_html of length characters. This means partitioned Table results are ready for use in downstream applications without any post processing.
• Expose endpoint url for s3 connectors By allowing for the endpoint url to be explicitly overwritten, this allows for any non-AWS data providers supporting the s3 protocol to be supported (i.e. minio).

Features

• change default hi_res model for pdf/image partition to yolox Now partitioning pdf/image using hi_res strategy utilizes yolox_quantized model isntead of detectron2_onnx model. This new default model has better recall for tables and produces more detailed categories for elements.
• XLSX can now reads subtables within one sheet Problem: Many .xlsx files are not created to be read as one full table per sheet. There are subtables, text and header along with more informations to extract from each sheet. Feature: This partition_xlsx now can reads subtable(s) within one .xlsx sheet, along with extracting other title and narrative texts. Importance: This enhance the power of .xlsx reading to not only one table per sheet, allowing user to capture more data tables from the file, if exists.
• Update Documentation on Element Types and Metadata: We have updated the documentation according to the latest element types and metadata. It includes the common and additional metadata provided by the Partitions and Connectors.

Fixes

• Fixes partition_pdf is_alnum reference bug Problem: The partition_pdf when attempt to get bounding box from element experienced a reference before assignment error when the first object is not text extractable. Fix: Switched to a flag when the condition is met. Importance: Crucial to be able to partition with pdf.
• 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.
• Fixes chunking when detection_class_prob appears in Element metadata Problem: when detection_class_prob appears in Element metadata, Elements will only be combined by chunk_by_title if they have the same detection_class_prob value (which is rare). This is unlikely a case we ever need to support and most often results in no chunking. Fix: detection_class_prob is included in the chunking list of metadata keys excluded for similarity comparison. Importance: This change allows chunk_by_title to operate as intended for documents which include detection_class_prob metadata in their Elements.

0.10.18

Enhancements

• 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, 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.

Features

• Adds links metadata in partition_pdf for fast 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

• 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 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 current unstructured. In this case, metadata fields were added which did not exist in the local ElementMetadata dataclass, and __init__() threw an error. Fix: remove nonexistent fields before instantiating in ElementMetadata.from_json(). Importance: Crucial to avoid breaking changes when adding fields.

• Fixes issue with Discord connector when a channel returns None Problem: Getting the jump_url from a nonexistent Discord channel fails. Fix: property jump_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 a SIGABTR when writing deltalake table even though the table was written correctly. Fix: put the writing function into a Process to ensure its execution to the fullest extent before returning to the main process. Importance: Improves stability of connectors using deltalake

• Fix 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.

0.10.16

Enhancements

• 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.

Features

Fixes

• *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.

0.10.15

Enhancements

• 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 many UncategorizedText 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 (with category_depth=1)
  • "Subheadline": Title (with category_depth=2)
  • "Abstract": NarrativeText
• Better ListItem grouping for PDF's (fast strategy). The partition_pdf with fast 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 if chunking_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 marks ocr_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, the unstructured library will better support languages for other non-image pipelines and/or support for other OCR engines.
• Removes UNSTRUCTURED_LANGUAGE env var usage and replaces language with languages 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 the languages parameter to any non-English language(s).
• Adds xlsx and xls filetype extensions to the skip_infer_table_types default list in partition. 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 the skip_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 unstructureds 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 to tesseract by half when partitioning pdf or image with tesseract
• 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 using source_format argument in the partition call.
• Adds PaddleOCR as an optional alternative to Tesseract for OCR in processing of PDF or Image files, it is installable via the makefile command install-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)

Features

• 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

Fixes

• add_pytesseract_bboxes_to_elements no longer returns nan values. The function logic is now broken into new methods _get_element_box and convert_multiple_coordinates_to_new_system
• Selecting a different model wasn't being respected when calling partition_image. Problem: partition_pdf allows for passing a model_name parameter. Given the similarity between the image and PDF pipelines, the expected behavior is that partition_image should support the same parameter, but partition_image was unintentionally not passing along its kwargs. 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.

0.10.14

Enhancements

• Update all connectors to use new downstream architecture
  • New click type added to parse comma-delimited string inputs
  • Some CLI options renamed

Features

Fixes

0.10.13

Enhancements

• 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

Features

• Add Jira Connector to be able to pull issues from a Jira organization
• Add clean_ligatures function to expand ligatures in text

Fixes

• 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)

0.10.12

Enhancements

• 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

Features

• Add Salesforce Connector to be able to pull Account, Case, Campaign, EmailMessage, Lead

Fixes

• Bump unstructured-inference
  • Avoid divide-by-zero errors swith safe_division (0.5.21)

0.10.11

Enhancements

• Bump unstructured-inference
  • Combine entire-page OCR output with layout-detected elements, to ensure full coverage of the page (0.5.19)

Features

• Add in ingest cli s3 writer

Fixes

• 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

0.10.10

Enhancements

• Adds text as an input parameter to partition_xml.
• partition_xml no longer runs through partition_text, avoiding incorrect splitting on carriage returns in the XML. Since partition_xml no longer calls partition_text, min_partition and max_partition are no longer supported in partition_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

Features

Fixes

• Fix a bug where mismatched elements and bboxes are passed into add_pytesseract_bbox_to_elements

0.10.9

Enhancements

• Fix test_json to handle only non-extra dependencies file types (plain-text)

Features

• Adds chunk_by_title to break a document into sections based on the presence of Title elements.
• add new extraction function extract_image_urls_from_html to extract all img related URL from html text.

Fixes

• Make cv2 dependency optional
• Edit add_pytesseract_bbox_to_elements's (ocr_only strategy) metadata.coordinates.points return type to Tuple for consistency.
• Re-enable test-ingest-confluence-diff for ingest tests
• Fix syntax for ingest test check number of files
• Fix csv and tsv partitioners loosing the first line of the files when creating elements

0.10.8

Enhancements

• Release docker image that installs Python 3.10 rather than 3.8

Features

Fixes

0.10.7

Enhancements

Features

Fixes

• Remove overly aggressive ListItem chunking for images and PDF's which typically resulted in inchorent elements.

0.10.6

Enhancements

• Enable partition_email and partition_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 in partition_pdf for hi_res and fast strategies
• Bump unstructured-inference
  • Set OMP_THREAD_LIMIT to 1 if not set for better tesseract perf (0.5.17)

Features

• Extract coordinates from PDFs and images when using OCR only strategy and add to metadata

Fixes

• Update partition_html to respect the order of <pre> tags.
• Fix bug in partition_pdf_or_image where two partitions were called if strategy == "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 to partition, partition_via_api, and partition_multiple_via_api.
• Fix documentation build workflow by pinning dependencies

0.10.5

Enhancements

• 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 in test_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

Features

• Add delta table connector

Fixes

0.10.4

• 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

Features

• Supports multipage TIFF image partitioning

Fixes

0.10.2

Enhancements

• 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.

Features

Fixes

0.10.1

Enhancements

• 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)

Features

Fixes

• 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)

0.10.0

Enhancements

• Add include_header kwarg to partition_xlsx and change default behavior to True
• Update the links and emphasized_texts metadata fields

Features

Fixes

0.9.3

Enhancements

• Pinned dependency cleanup.
• Update partition_csv to always use soupparser_fromstring to parse html text
• Update partition_tsv to always use soupparser_fromstring to parse html text
• Add metadata.section to capture epub table of contents data
• Add unique_element_ids kwarg to partition functions. If True, will use a UUID for element IDs instead of a SHA-256 hash.
• Update partition_xlsx to always use soupparser_fromstring to parse html text
• Add functionality to switch html text parser based on whether the html text contains emoji
• Add functionality to check if a string contains any emoji characters
• Add CI tests around Notion

Features

• Add Airtable Connector to be able to pull views/tables/bases from an Airtable organization

Fixes

• fix pdf partition of list items being detected as titles in OCR only mode
• make notion module discoverable
• fix emails with Content-Distribution: inline and Content-Distribution: attachment with no filename
• Fix email attachment filenames which had = in the filename itself

0.9.2

Enhancements

• 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

Features

• Adds Sharepoint connector.

Fixes

• Bump unstructured-inference==0.5.9:
  • ignores Tesseract errors where no text is extracted for tiles that indeed, have no text

0.9.1

Enhancements

• Adds --partition-pdf-infer-table-structure to unstructured-ingest.
• Enable partition_html to skip headers and footers with the skip_headers_and_footers flag.
• Update partition_doc and partition_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

Features

Fixes

• 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 the min_partition less likely.
• Fix bug where ingest test check for number of files fails in smoke test
• Fix unstructured-ingest entrypoint failure

0.9.0

Enhancements

• Dependencies are now split by document type, creating a slimmer base installation.

0.8.8

Enhancements

Features

Fixes

• Rename "date" field to "last_modified"
• Adds Box connector

Fixes

0.8.7

Enhancements

• Put back useful function split_by_paragraph

Features

Fixes

• Fix argument order in NLTK download step

0.8.6

Enhancements

Features

Fixes

• Remove debug print lines and non-functional code

0.8.5

Enhancements

• 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

0.8.3

Enhancements

Features

Fixes

• NLTK now only gets downloaded if necessary.
• Handling for empty tables in Word Documents and PowerPoints.

0.8.4

Enhancements

• 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

Features

• 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

• Fixes issue with email partitioning where From field was being assigned the To field value.
• Use the image_metadata property of the PageLayout instance to get the page image info in the document_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 a text/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 for partition_via_api and partition_multiple_via_api

0.8.1

Enhancements

• Add support for Python 3.11

Features

Fixes

• Fixed auto strategy detected scanned document as having extractable text and using fast 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.

0.8.0

Enhancements

• Allow model used for hi res pdf partition strategy to be chosen when called.
• Updated inference package

Features

• Add metadata_filename parameter across all partition functions

Fixes

• 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.

BREAKING CHANGES

• 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.

0.7.12

Enhancements

• Adds include_metadata kwarg to partition_doc, partition_docx, partition_email, partition_epub, partition_json, partition_msg, partition_odt, partition_org, partition_pdf, partition_ppt, partition_pptx, partition_rst, and partition_rtf

Features

• Add Elasticsearch connector for ingest cli to pull specific fields from all documents in an index.
• Adds Dropbox connector

Fixes

• 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

0.7.11

Enhancements

• 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 and partition_msg will now process attachments if process_attachments=True and a attachment partitioning functions is passed through with attachment_partitioner=partition.

Features

Fixes

• 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

0.7.10

Enhancements

• Adds a max_partition parameter to partition_text, partition_pdf, partition_email, partition_msg and partition_xml that sets a limit for the size of an individual document elements. Defaults to 1500 for everything except partition_xml, which has a default value of None.
• DRY connector refactor

Features

• hi_res model for pdfs and images is selectable via environment variable.

Fixes

• 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

0.7.9

Enhancements

• Improvements to string check for leafs in partition_xml.
• Adds --partition-ocr-languages to unstructured-ingest.

Features

• Adds partition_org for processed Org Mode documents.

Fixes

0.7.8

Enhancements

Features

• Adds Google Cloud Service connector

Fixes

• Updates the parse_email for partition_eml so that unstructured-api passes the smoke tests
• partition_email now works if there is no message content
• Updates the "fast" strategy for partition_pdf so that it's able to recursively
• Adds recursive functionality to all fsspec connectors
• Adds generic --recursive ingest flag

0.7.7

Enhancements

• Adds functionality to replace the MIME encodings for eml files with one of the common encodings if a unicode error occurs
• Adds missed file-like object handling in detect_file_encoding
• Adds functionality to extract charset info from eml files

Features

• Added coordinate system class to track coordinate types and convert to different coordinate

Fixes

• Adds an html_assemble_articles kwarg to partition_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 on element before looking for pagebreaks in partition_docx.

0.7.6

Enhancements

• 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

Features

• 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 to detect_filetype.

Fixes

• Remove fake api key in test partition_via_api since we now require valid/empty api keys
• Page number defaults to None instead of 1 when page number is not present in the metadata. A page number of None 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.

0.7.5

Enhancements

• Adds functionality to sort elements in partition_pdf for fast strategy
• Adds ingest tests with --fast strategy on PDF documents
• Adds --api-key to unstructured-ingest

Features

• Adds partition_rst for processed ReStructured Text documents.

Fixes

• Adds handling for emails that do not have a datetime to extract.
• Adds pdf2image package as core requirement of unstructured (with no extras)

0.7.4

Enhancements

• Allows passing kwargs to request data field for partition_via_api and partition_multiple_via_api
• Enable MIME type detection if libmagic is not available
• Adds handling for empty files in detect_filetype and partition.

Features

Fixes

• Reslove grpcio import issue on weaviate.schema.validate_schema for python 3.9 and 3.10
• Remove building detectron2 from source in Dockerfile

0.7.3

Enhancements

• Update IngestDoc abstractions and add data source metadata in ElementMetadata

Features

Fixes

• Pass strategy parameter down from partition for partition_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.

0.7.2

Enhancements

• Adds an optional encoding kwarg to elements_to_json and elements_from_json
• Bump version of base image to use new stable version of tesseract

Features

Fixes

• Update the read_txt_file utility function to keep using spooled_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 from partition_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

0.7.1

Enhancements

Features

• Add stage_for_weaviate to stage unstructured 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.

Fixes

0.7.0

Enhancements

• Installing detectron2 from source is no longer required when using the local-inference extra.
• Updates .pptx parsing to include text in tables.

Features

Fixes

• Fixes an issue in _add_element_metadata that caused all elements to have page_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 when include_metadata=False
• A ValueError now raises if file_filename is not specified when you use partition_via_api with a file-like object.

0.6.11

Enhancements

• Supports epub tests since pandoc is updated in base image

Features

Fixes

0.6.10

Enhancements

• XLS support from auto partition

Features

Fixes

0.6.9

Enhancements

• fast strategy for pdf now keeps element bounding box data
• setup.py refactor

Features

Fixes

• 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

0.6.8

Enhancements

Features

• Add partition_csv for CSV files.

Fixes

0.6.7

Enhancements

• 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.

Features

• Add partition_xml for XML files.
• Add partition_xlsx for Microsoft Excel documents.

Fixes

• Supports hml filetype for partition as a variation of html filetype.
• Makes pytesseract a function level import in partition_pdf so you can use the "fast" or "hi_res" strategies if pytesseract is not installed. Also adds the required_dependencies decorator for the "hi_res" and "ocr_only" strategies.
• Fix to ensure filename is tracked in metadata for docx tables.

0.6.6

Enhancements

• Adds an "auto" strategy that chooses the partitioning strategy based on document characteristics and function kwargs. This is the new default strategy for partition_pdf and partition_image. Users can maintain existing behavior by explicitly setting strategy="hi_res".
• Added an additional trace logger for NLP debugging.
• Add get_date method to ElementMetadata for converting the datestring to a datetime object.
• Cleanup the filename attribute on ElementMetadata to remove the full filepath.

Features

• Added table reading as html with URL parsing to partition_docx in docx
• Added metadata field for text_as_html for docx files

Fixes

• fileutils/file_type check json and eml decode ignore error
• partition_email was updated to more flexibly handle deviations from the RFC-2822 standard. The time in the metadata returns None if the time does not match RFC-2822 at all.
• Include all metadata fields when converting to dataframe or CSV

0.6.5

Enhancements

• Added support for SpooledTemporaryFile file argument.

Features

Fixes

0.6.4

Enhancements

• Added an "ocr_only" strategy for partition_pdf. Refactored the strategy decision logic into its own module.

Features

Fixes

0.6.3

Enhancements

• Add an "ocr_only" strategy for partition_image.

Features

• 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.

Fixes

• Updates the grouping logic in the partition_pdf fast strategy to group together text in the same bounding box.

0.6.2

Enhancements

• Added logic to partition_pdf for detecting copy protected PDFs and falling back to the hi res strategy when necessary.

Features

• Add partition_via_api for partitioning documents through the hosted API.

Fixes

• Fix how exceeds_cap_ratio handles empty (returns True instead of False)
• Updates detect_filetype to properly detect JSONs when the MIME type is text/plain.

0.6.1

Enhancements

• Updated the table extraction parameter name to be more descriptive

Features

Fixes

0.6.0

Enhancements

• Adds an ssl_verify kwarg to partition and partition_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 and partition_image through the ocr_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.

Features

• Table extraction is now possible for pdfs from partition and partition_pdf.
• Adds support for extracting attachments from .msg files

Fixes

• Adds an ssl_verify kwarg to partition and partition_html to enable turning off SSL verification for HTTP requests. SSL verification is on by default.

0.5.13

Enhancements

• Allow headers to be passed into partition when url is used.

Features

• bytes_string_to_string cleaning brick for bytes string output.

Fixes

• Fixed typo in call to exactly_one in partition_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 and partition_text group broken paragraphs to avoid fragmented NarrativeText elements.
• .json files resolved as "application/json" on centos7 (or other installs with older libmagic libs)

0.5.12

Enhancements

• 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

Features

• 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 a url kwarg in addition to file and filename.

Fixes

• 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.

0.5.11

Enhancements

Features

Fixes

• Guard against null style attribute in docx document elements
• Update HTML encoding to better support foreign language characters

0.5.10

Enhancements

• Updated inference package
• Add sender, recipient, date, and subject to element metadata for emails

Features

• Added --download-only parameter to unstructured-ingest

Fixes

• FileNotFound error when filename is provided but file is not on disk

0.5.9

Enhancements

Features

Fixes

• Convert file to str in helper split_by_paragraph for partition_text

0.5.8

Enhancements

• Update elements_to_json to return string when filename is not specified
• elements_from_json may take a string instead of a filename with the text kwarg
• detect_filetype now does a final fallback to file extension.
• Empty tags are now skipped during the depth check for HTML processing.

Features

• Add local file system to unstructured-ingest
• Add --max-docs parameter to unstructured-ingest
• Added partition_msg for processing MSFT Outlook .msg files.

Fixes

• convert_file_to_text now passes through the source_format and target_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.

BREAKING CHANGES

• stage_for_transformers now returns a list of elements, making it consistent with other staging bricks

0.5.7

Enhancements

• Refactored codebase using exactly_one
• Adds ability to pass headers when passing a url in partition_html()
• Added optional content_type and file_filename parameters to partition() to bypass file detection

Features

• Add --flatten-metadata parameter to unstructured-ingest
• Add --fields-include parameter to unstructured-ingest

Fixes

0.5.6

Enhancements

• contains_english_word(), used heavily in text processing, is 10x faster.

Features

• Add --metadata-include and --metadata-exclude parameters to unstructured-ingest
• Add clean_non_ascii_chars to remove non-ascii characters from unicode string

Fixes

• Fix problem with PDF partition (duplicated test)

0.5.4

Enhancements

• Added Biomedical literature connector for ingest cli.
• Add FsspecConnector to easily integrate any existing fsspec filesystem as a connector.
• Rename s3_connector.py to s3.py for readability and consistency with the rest of the connectors.
• Now S3Connector relies on s3fs instead of on boto3, and it inherits from FsspecConnector.
• 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.

Features

• Add AzureBlobStorageConnector based on its fsspec implementation inheriting from FsspecConnector
• Add partition_epub for partitioning e-books in EPUB3 format.

Fixes

• Fixes processing for text files with message/rfc822 MIME type.
• Open xml files in read-only mode when reading contents to construct an XMLDocument.

0.5.3

Enhancements

• auto.partition() can now load Unstructured ISD json documents.
• Simplify partitioning functions.
• Improve logging for ingest CLI.

Features

• 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 the partition_(text/email/html) functions.
• Added Google Drive connector for ingest cli.
• Added Gitlab connector for ingest cli.

Fixes

0.5.2

Enhancements

• 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.

Features

Fixes

• setup_ubuntu.sh no longer fails in some contexts by interpreting DEBIAN_FRONTEND=noninteractive as a command
• unstructured-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.

0.5.1

Enhancements

Features

Fixes

• 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 for unstructured-ingest --github-url ....

0.5.0

Enhancements

• Add requires_dependencies Python decorator to check dependencies are installed before instantiating a class or running a function

Features

• Added Wikipedia connector for ingest cli.

Fixes

• Fix process_document file cleaning on failure
• Fixes an error introduced in the metadata tracking commit that caused NarrativeText and FigureCaption elements to be represented as Text in HTML documents.

0.4.16

Enhancements

• Fallback to using file extensions for filetype detection if libmagic is not present

Features

• Added setup script for Ubuntu
• Added GitHub connector for ingest cli.
• Added partition_md partitioner.
• Added Reddit connector for ingest cli.

Fixes

• Initializes connector properly in ingest.main::MainProcess
• Restricts version of unstructured-inference to avoid multithreading issue

0.4.15

Enhancements

• Added elements_to_json and elements_from_json for easier serialization/deserialization
• convert_to_dict, dict_to_elements and convert_to_csv are now aliases for functions that use the ISD terminology.

Fixes

• Update to ensure all elements are preserved during serialization/deserialization

0.4.14

• Automatically install nltk models in the tokenize module.

0.4.13

• Fixes unstructured-ingest cli.

0.4.12

• Adds console_entrypoint for unstructured-ingest, other structure/doc updates related to ingest.
• Add parser parameter to partition_html.

0.4.11

• Adds partition_doc for partitioning Word documents in .doc format. Requires libreoffice.
• Adds partition_ppt for partitioning PowerPoint documents in .ppt format. Requires libreoffice.

0.4.10

• Fixes ElementMetadata so that it's JSON serializable when the filename is a Path object.

0.4.9

• Added ingest modules and s3 connector, sample ingest script
• Default to url=None for partition_pdf and partition_image
• Add ability to skip English specific check by setting the UNSTRUCTURED_LANGUAGE env var to "".
• Document Element objects now track metadata

0.4.8

• Modified XML and HTML parsers not to load comments.

0.4.7

• 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.

0.4.6

• 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 to NarrativeText 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

0.4.4

• Updated partition_pdf and partition_image to return unstructured Element objects
• Fixed the healthcheck url path when partitioning images and PDFs via API
• Adds an optional coordinates attribute to document objects
• Adds FigureCaption and CheckBox 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

0.4.3

• 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.

0.4.2

• Added partition_image to process documents in an image format.
• Fixed utf-8 encoding error in partition_email with attachments for text/html

0.4.1

• Added support for text files in the partition function
• Pinned opencv-python for easier installation on Linux

0.4.0

• 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 and partition_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 and partition_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 images find_embedded_images
• Added get_directory_file_info for summarizing information about source documents

0.3.5

• 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 processing div 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 Elements to a pandas dataframe.
• Add plain text functionality to partition_email

0.3.4

• Python-3.7 compat

0.3.3

• 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

0.3.2

• Added translate_text brick for translating text between languages
• Add an apply method to make it easier to apply cleaners to elements

0.3.1

• Added __init.py__ to partition

0.3.0

• Implement staging brick for Argilla. Converts lists of Text elements to argilla 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.

0.2.6

• 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

0.2.5

• Update python requirement to >=3.7

0.2.4

• Add alternative way of importing Final to support google colab

0.2.3

• Add cleaning bricks for removing prefixes and postfixes
• Add cleaning bricks for extracting text before and after a pattern

0.2.2

• Add staging brick for Datasaur

0.2.1

• Added brick to convert an ISD dictionary to a list of elements
• Update PDFDocument to use the from_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

0.2.0

• Initial release of unstructured