jina.types.document.traversable

class jina.types.document.traversable.Traversable[source]

Bases: object

Helper class to expose common interface to the traversal logic of the BaseExecutable Driver. It is important to note that it checks the matching structure of docs and groundtruths. It is important while traversing to ensure that then the driver can be applied at a comparable level of granularity and adjacency. This does not imply that you can’t compare at the end a document with 10 matches with a groundtruth with 20 matches

Parameters
  • doc – Target Document.

  • groundtruth – The Document with desired state.

property matches

Get the pairs between matches and Groundtruth.

Return type

Iterable[Traversable]

property chunks

Get the pairs between chunks and Groundtruth.

Return type

Iterable[Traversable]