jina.drivers.querylang.select

class jina.drivers.querylang.select.ExcludeQL(fields, traversal_paths=('r'), *args, **kwargs)[source]

Bases: jina.drivers.QuerySetReader, jina.drivers.FlatRecursiveMixin, jina.drivers.BaseRecursiveDriver

Clean some fields from the document-level protobuf to reduce the total size of the request Example:: - !ExcludeQL with:

fields:
  • chunks

  • buffer

ExcludeQL will avoid buffer and chunks fields to be sent to the next Pod

Parameters
  • fields (Union[Tuple, str]) – the pruned field names in tuple

  • traversal_paths (Tuple[str]) – the traversal paths :param args: additional positional arguments which are just used for the parent initialization :param kwargs: additional key value arguments which are just used for the parent initialization

runtime: Optional[ZEDRuntime]
class jina.drivers.querylang.select.SelectQL(fields, traversal_paths=('r'), *args, **kwargs)[source]

Bases: jina.drivers.querylang.select.ExcludeQL

Selects some fields from the chunk-level protobuf to reduce the total size of the request, it works with the opposite logic as :class:`ExcludeQL

Example:: - !SelectQL with:

fields:
  • matches

SelectQL will ensure that the outgoing documents only contain the field matches

runtime: Optional[ZEDRuntime]
class jina.drivers.querylang.select.ExcludeReqQL(fields, traversal_paths=('r'), *args, **kwargs)[source]

Bases: jina.drivers.querylang.select.ExcludeQL

Clean up request from the request-level protobuf message to reduce the total size of the message

This is often useful when the proceeding Pods require only a signal, not the full message.

runtime: Optional[ZEDRuntime]
class jina.drivers.querylang.select.SelectReqQL(fields, traversal_paths=('r'), *args, **kwargs)[source]

Bases: jina.drivers.querylang.select.ExcludeReqQL

Clean up request from the request-level protobuf message to reduce the total size of the message, it works with the opposite logic as :class:`ExcludeReqQL

runtime: Optional[ZEDRuntime]