jina.types.arrays.match

class jina.types.arrays.match.MatchArray[source]

Bases: jina.types.arrays.document.DocumentArray

MatchArray inherits from DocumentArray. It’s a subset of Documents that represents the matches

Parameters
  • docs_proto (Document) – List of matches of the reference_doc

  • reference_doc (Document) – Reference Document for the sub-documents

MatchSet is deprecated. A new class name is MatchArray.

append(document, **kwargs)[source]

Add a matched document to the current Document.

Parameters
  • document (Document) – Sub-document to be added

  • kwargs – Extra key value arguments

Returns

the newly added sub-document in Document view

Return type

Document view

property reference_doc

Get the document that this MatchArray referring to. :rtype: Document :return: the document the match refers to

property granularity

Get granularity of all document in this array. :rtype: int :return: the granularity of the documents of which these are match

property adjacency

Get the adjacency of all document in this array. :rtype: int :return: the adjacency of the array of matches