Fluent Interface

Documents provide a simple fluent interface that let you process (often preprocess) a Document object by chaining methods. For example to read an image file as numpy.ndarray, resize it, normalize it and then store it to another file:

from docarray import Document

d = (
    Document(uri='apple.png')
    .load_uri_to_image_tensor()
    .set_image_tensor_shape((64, 64))
    .set_image_tensor_normalization()
    .save_image_tensor_to_file('apple1.png')
)

Original apple.png

Processed apple1.png

Note that chaining methods always modifies the original Document in-place. That means the above example is equivalent to:

from docarray import Document

d = Document(uri='apple.png')

(
    d.load_uri_to_image_tensor()
    .set_image_tensor_shape((64, 64))
    .set_image_tensor_normalization()
    .save_image_tensor_to_file('apple1.png')
)

Methods

All the following methods can be chained.

BlobData

Provide helper functions for Document to handle binary data.

• convert_blob_to_datauri()

• load_uri_to_blob()

• save_blob_to_file()

ImageData

Provide helper functions for Document to support image data.

• convert_blob_to_image_tensor()

• convert_image_tensor_to_blob()

• convert_image_tensor_to_sliding_windows()

• convert_image_tensor_to_uri()

• load_uri_to_image_tensor()

• save_image_tensor_to_file()

• set_image_tensor_channel_axis()

• set_image_tensor_inv_normalization()

• set_image_tensor_normalization()

• set_image_tensor_shape()

Convert

Provide helper functions for Document to support conversion between tensor, text and blob.

• convert_blob_to_tensor()

• convert_tensor_to_blob()

• convert_uri_to_datauri()

ContentProperty

Provide helper functions for Document to allow universal content property access.

• convert_content_to_datauri()

TextData

Provide helper functions for Document to support text data.

• convert_tensor_to_text()

• convert_text_to_datauri()

• convert_text_to_tensor()

• load_uri_to_text()

SingletonSugar

Provide sugary syntax for Document by inheriting methods from DocumentArray.

• embed()

• match()

FeatureHash

Provide helper functions for feature hashing.

• embed_feature_hashing()

Porting

Provide helper functions for Document to convert between serialization types.

• from_base64()

• from_bytes()

• from_dict()

• from_json()

Protobuf

• from_protobuf()

Pydantic

Provide helper functions to convert to/from a Pydantic model.

• from_pydantic_model()

Strawberry

Provide helper functions to convert to/from a Strawberry model.

• from_strawberry_type()

AudioData

Provide helper functions for Document to support audio data.

• load_uri_to_audio_tensor()

• save_audio_tensor_to_file()

MeshData

Provide helper functions for Document to support 3D mesh data and point cloud.

• load_uri_to_point_cloud_tensor()

VideoData

Provide helper functions for Document to support video data.

• load_uri_to_video_tensor()

• save_video_tensor_to_file()

UriFile

Provide helper functions for Document to dump content to a file.

• save_uri_to_file()