You want to get, manipulate, and print or save, the contents of the document elements and metadata from the processed data that Unstructured returns.
Each element in the document elements contains fields for that element’s type, its ID, the extracted text, and associated metadata.
The programmatic approach you take to get these document elements will depend on which tool, SDK, or library you use:
Ingest CLI
For the Unstructured Ingest CLI, you can use a tool such as jq to work with a JSON file that the CLI outputs after the processing is complete.
For example, the following script uses jq
to access and print each element’s ID, text, and originating file name:
Ingest Python library
For the Unstructured Ingest Python library, you can use the standard Python json.load function to load into a Python dictionary the contents of a JSON file that the Ingest Python library outputs after the processing is complete.
For example, the following code example uses standard Python to access and print each element’s ID, text, and originating file name:
Open-source library
For the Unstructured open-source library, calling the partition_via_api
function returns a list of elements (list[Element]
). For example:
You can use standard Python list operations on this list.
You can also use standard Python looping techniques on this list to access each element in this list.
Each individual element has the following attributes:
.text
provides the element’s text
field value as a str
. See Element example..metadata
provides the element’s metadata
field as an ElementMetadata
object. See Metadata..category
provides the element’s type
field value as a str
. See Element type..id
provides the element’s element_id
value as a str
. See Element ID.In addition, the following methods are available:
.convert_coordinates_to_new_system()
converts the element’s location coordinates, if any, to a new coordinate system. See Element’s coordinates..to_dict()
gets the element’s content as a standard Python key-value dictionary (dict[str, Any]
).For example:
To serialize this list as a Python dictionary, you can use the elements_to_dicts
method, for example:
To serialize this list as JSON, you can use the elements_to_json
function to convert the list of elements (Iterable[Element]
) into a JSON-formatted string and then print or save that string. For example:
You want to get, manipulate, and print or save, the contents of the document elements and metadata from the processed data that Unstructured returns.
Each element in the document elements contains fields for that element’s type, its ID, the extracted text, and associated metadata.
The programmatic approach you take to get these document elements will depend on which tool, SDK, or library you use:
Ingest CLI
For the Unstructured Ingest CLI, you can use a tool such as jq to work with a JSON file that the CLI outputs after the processing is complete.
For example, the following script uses jq
to access and print each element’s ID, text, and originating file name:
Ingest Python library
For the Unstructured Ingest Python library, you can use the standard Python json.load function to load into a Python dictionary the contents of a JSON file that the Ingest Python library outputs after the processing is complete.
For example, the following code example uses standard Python to access and print each element’s ID, text, and originating file name:
Open-source library
For the Unstructured open-source library, calling the partition_via_api
function returns a list of elements (list[Element]
). For example:
You can use standard Python list operations on this list.
You can also use standard Python looping techniques on this list to access each element in this list.
Each individual element has the following attributes:
.text
provides the element’s text
field value as a str
. See Element example..metadata
provides the element’s metadata
field as an ElementMetadata
object. See Metadata..category
provides the element’s type
field value as a str
. See Element type..id
provides the element’s element_id
value as a str
. See Element ID.In addition, the following methods are available:
.convert_coordinates_to_new_system()
converts the element’s location coordinates, if any, to a new coordinate system. See Element’s coordinates..to_dict()
gets the element’s content as a standard Python key-value dictionary (dict[str, Any]
).For example:
To serialize this list as a Python dictionary, you can use the elements_to_dicts
method, for example:
To serialize this list as JSON, you can use the elements_to_json
function to convert the list of elements (Iterable[Element]
) into a JSON-formatted string and then print or save that string. For example: