John c58b261feb
chunk_by_title decorator (#1304)
### Summary

Partial solution to #1185.
Related to #1222.
Creates decorator from `chunk_by_title` cleaning brick.
Breaks a document into sections based on the presence of Title elements.
Also starts a new section under the following conditions:

- If metadata changes, indicating a change in section or page or a
switch to processing attachments. If `multipage_sections=True`, sections
can span pages. `multipage_sections` defaults to True.
- If the length of the section exceeds `new_after_n_chars` characters.
The default is 1500. The **chunking function does not split individual
elements**, so it's possible for a section to exceed that threshold if
an individual element if over `new_after_n_chars characters`, which
could occur with a long NarrativeText element.

Combines sections under these conditions
- Sections under `combine_under_n_chars` characters are combined. The
default is 500.

### Testing

from unstructured.partition.html import partition_html

url = "https://understandingwar.org/backgrounder/russian-offensive-campaign-assessment-august-27-2023-0"
chunks = partition_html(url=url, chunking_strategy="by_title")

for chunk in chunks:
    print(chunk)
    print("\n\n" + "-"*80)
    input()
2023-09-11 21:00:14 +00:00

153 lines
4.9 KiB
Python

from unstructured.chunking.title import chunk_by_title
from unstructured.cleaners.core import clean_extra_whitespace
from unstructured.documents.elements import Title
from unstructured.partition.json import partition_json
from unstructured.partition.rst import partition_rst
from unstructured.staging.base import elements_to_json
def test_partition_rst_from_filename(filename="example-docs/README.rst"):
elements = partition_rst(filename=filename)
assert elements[0] == Title("Example Docs")
assert elements[0].metadata.filetype == "text/x-rst"
for element in elements:
assert element.metadata.filename == "README.rst"
def test_partition_rst_from_filename_with_metadata_filename(
filename="example-docs/README.rst",
):
elements = partition_rst(filename=filename, metadata_filename="test")
assert all(element.metadata.filename == "test" for element in elements)
def test_partition_rst_from_file(filename="example-docs/README.rst"):
with open(filename, "rb") as f:
elements = partition_rst(file=f)
assert elements[0] == Title("Example Docs")
assert elements[0].metadata.filetype == "text/x-rst"
for element in elements:
assert element.metadata.filename is None
def test_partition_rst_from_file_with_metadata_filename(
filename="example-docs/README.rst",
):
with open(filename, "rb") as f:
elements = partition_rst(file=f, metadata_filename="test")
assert elements[0] == Title("Example Docs")
for element in elements:
assert element.metadata.filename == "test"
def test_partition_rst_from_filename_exclude_metadata(
filename="example-docs/README.rst",
):
elements = partition_rst(filename=filename, include_metadata=False)
for i in range(len(elements)):
assert elements[i].metadata.to_dict() == {}
def test_partition_rst_from_file_exclude_metadata(filename="example-docs/README.rst"):
with open(filename, "rb") as f:
elements = partition_rst(file=f, include_metadata=False)
for i in range(len(elements)):
assert elements[i].metadata.to_dict() == {}
def test_partition_rst_metadata_date(
mocker,
filename="example-docs/README.rst",
):
mocked_last_modification_date = "2029-07-05T09:24:28"
mocker.patch(
"unstructured.partition.html.get_last_modified_date",
return_value=mocked_last_modification_date,
)
elements = partition_rst(
filename=filename,
)
assert elements[0].metadata.last_modified == mocked_last_modification_date
def test_partition_rst_with_custom_metadata_date(
mocker,
filename="example-docs/README.rst",
):
mocked_last_modification_date = "2029-07-05T09:24:28"
expected_last_modification_date = "2020-07-05T09:24:28"
mocker.patch(
"unstructured.partition.html.get_last_modified_date",
return_value=mocked_last_modification_date,
)
elements = partition_rst(
filename=filename,
metadata_last_modified=expected_last_modification_date,
)
assert elements[0].metadata.last_modified == expected_last_modification_date
def test_partition_rst_from_file_metadata_date(
mocker,
filename="example-docs/README.rst",
):
mocked_last_modification_date = "2029-07-05T09:24:28"
mocker.patch(
"unstructured.partition.html.get_last_modified_date_from_file",
return_value=mocked_last_modification_date,
)
with open(filename, "rb") as f:
elements = partition_rst(
file=f,
)
assert elements[0].metadata.last_modified == mocked_last_modification_date
def test_partition_rst_from_file_with_custom_metadata_date(
mocker,
filename="example-docs/README.rst",
):
mocked_last_modification_date = "2029-07-05T09:24:28"
expected_last_modification_date = "2020-07-05T09:24:28"
mocker.patch(
"unstructured.partition.html.get_last_modified_date_from_file",
return_value=mocked_last_modification_date,
)
with open(filename, "rb") as f:
elements = partition_rst(file=f, metadata_last_modified=expected_last_modification_date)
assert elements[0].metadata.last_modified == expected_last_modification_date
def test_partition_rst_with_json(filename="example-docs/README.rst"):
elements = partition_rst(filename=filename)
test_elements = partition_json(text=elements_to_json(elements))
assert len(elements) == len(test_elements)
assert clean_extra_whitespace(elements[0].text) == clean_extra_whitespace(test_elements[0].text)
assert elements[0].metadata.filename == test_elements[0].metadata.filename
for i in range(len(elements)):
assert elements[i] == test_elements[i]
def test_add_chunking_strategy_on_partition_rst(filename="example-docs/README.rst"):
elements = partition_rst(filename=filename)
chunk_elements = partition_rst(filename, chunking_strategy="by_title")
chunks = chunk_by_title(elements)
assert chunk_elements != elements
assert chunk_elements == chunks