jina.types.document package¶

Submodules¶

Module contents¶

class jina.types.document.Document(document=None, field_resolver=None, copy=False, hash_content=True, **kwargs)[source]¶

Bases: jina.types.mixin.ProtoTypeMixin

Document is one of the primitive data type in Jina.

It offers a Pythonic interface to allow users access and manipulate jina.jina_pb2.DocumentProto object without working with Protobuf itself.

To create a Document object, simply:

from jina import Document
d = Document()
d.text = 'abc'

Jina requires each Document to have a string id. You can set a custom one, or if non has been set a random one will be assigned.

Or you can use Document as a context manager:

with Document() as d:
    d.text = 'hello'

assert d.id  # now `id` has value

To access and modify the content of the document, you can use text, blob, and buffer. Each property is implemented with proper setter, to improve the integrity and user experience. For example, assigning doc.blob or doc.embedding can be simply done via:

import numpy as np

# to set as content
d.content = np.random.random([10, 5])

# to set as embedding
d.embedding = np.random.random([10, 5])

MIME type is auto set/guessed when setting content and uri

Document also provides multiple way to build from existing Document. You can build Document from jina_pb2.DocumentProto, bytes, str, and Dict. You can also use it as view (i.e. weak reference when building from an existing jina_pb2.DocumentProto). For example,

a = DocumentProto()
b = Document(a, copy=False)
a.text = 'hello'
assert b.text == 'hello'

You can leverage the convert_a_to_b() interface to convert between content forms.

Parameters

document (Optional[~DocumentSourceType]) – the document to construct from. If bytes is given then deserialize a DocumentProto; dict is given then parse a DocumentProto from it; str is given, then consider it as a JSON string and parse a DocumentProto from it; finally, one can also give DocumentProto directly, then depending on the copy, it builds a view or a copy from it.
copy (bool) – when document is given as a DocumentProto object, build a view (i.e. weak reference) from it or a deep copy from it.
field_resolver (Optional[Dict[str, str]]) – a map from field names defined in document (JSON, dict) to the field names defined in Protobuf. This is only used when the given document is a JSON string or a Python dict.
kwargs – other parameters to be set _after_ the document is constructed
hash_content (bool) – whether to hash the content of the Document

Note

When document is a JSON string or Python dictionary object, the constructor will only map the values from known fields defined in Protobuf, all unknown fields are mapped to document.tags. For example,

d = Document({'id': '123', 'hello': 'world', 'tags': {'good': 'bye'}})

assert d.id == '123'  # true
assert d.tags['hello'] == 'world'  # true
assert d.tags['good'] == 'bye'  # true

pop(*fields)[source]¶

Remove the values from the given fields of this Document.

Parameters: fields – field names
Return type: None

clear()[source]¶

Remove all values from all fields of this Document.

Return type: None

property weight¶

Return type: float
Returns: the weight of the document

property modality¶

Return type: str
Returns: the modality of the document.

property content_hash¶

Get the content hash of the document.

Returns: the content_hash from the proto

property tags¶

Return the tags field of this Document as a Python dict

Return type: StructView
Returns: a Python dict view of the tags.

update(source, fields=None)[source]¶

Updates fields specified in fields from the source to current Document.

Parameters

source (Document) – source Document object.
fields (Optional[List[str]]) – a list of field names that included from the current document, if not specified, merge all fields.

Note

*. destination will be modified in place, source will be unchanged

Return type: None

update_content_hash(fields=('text', 'blob', 'buffer', 'embedding', 'uri', 'tags', 'mime_type', 'granularity', 'adjacency'))[source]¶

Update the document hash according to its content.

Parameters: fields (Tuple[str]) – a tuple of field names that inclusive when computing content hash.
Return type: None

property id¶

The document id in hex string, for non-binary environment such as HTTP, CLI, HTML and also human-readable. it will be used as the major view.

Return type: str
Returns: the id from the proto

property parent_id¶

The document’s parent id in hex string, for non-binary environment such as HTTP, CLI, HTML and also human-readable. it will be used as the major view.

Return type: str
Returns: the parent id from the proto

get_sparse_blob(sparse_ndarray_cls_type, **kwargs)[source]¶

Return blob of the content of a Document as an sparse array.

Parameters

sparse_ndarray_cls_type (Type[BaseSparseNdArray]) – Sparse class type, such as SparseNdArray.
kwargs – Additional key value argument, for scipy backend, we need to set the keyword sp_format as one of the scipy supported sparse format, such as coo or csr.

Return type

SparseArrayType

Returns

the blob from the proto as an sparse array

property blob¶

Return blob, one of the content form of a Document.

Note

Use content to return the content of a Document

This property will return the blob of the Document as a Dense or Sparse array depending on the actual proto instance stored. In the case where the blob stored is sparse, it will return them as a coo matrix. If any other type of sparse type is desired, use the :meth:`get_sparse_blob.

Return type: ArrayType
Returns: the blob content from the proto

get_sparse_embedding(sparse_ndarray_cls_type, **kwargs)[source]¶

Return embedding of the content of a Document as an sparse array.

Parameters

sparse_ndarray_cls_type (Type[BaseSparseNdArray]) – Sparse class type, such as SparseNdArray.
kwargs – Additional key value argument, for scipy backend, we need to set the keyword sp_format as one of the scipy supported sparse format, such as coo or csr.

Return type

SparseArrayType

Returns

the embedding from the proto as an sparse array

property embedding¶

Return embedding of the content of a Document.

Note

This property will return the embedding of the Document as a Dense or Sparse array depending on the actual proto instance stored. In the case where the embedding stored is sparse, it will return them as a coo matrix. If any other type of sparse type is desired, use the :meth:`get_sparse_embedding.

Return type: SparseArrayType
Returns: the embedding from the proto

property matches¶

Get all matches of the current document.

Return type: MatchArray
Returns: the array of matches attached to this document

property chunks¶

Get all chunks of the current document.

Return type: ChunkArray
Returns: the array of chunks of this document

set_attributes(**kwargs)[source]¶

Bulk update Document fields with key-value specified in kwargs