jina.types.sets.match

class jina.types.sets.match.MatchSet(docs_proto, reference_doc)[source]

Bases: jina.types.sets.document.DocumentSet

append(document, **kwargs)[source]

Add a matched document to the current Document

Return type

Document

Returns

the newly added sub-document in Document view

property reference_doc

Get the document that this MatchSet referring to

Return type

Document

property granularity

The granularity of all document in this set

Return type

int

property adjacency

The adjacency of all document in this set

Return type

int