jina.clients.base package

Submodules

Module contents

Module containing the Base Client for Jina.

class jina.clients.base.BaseClient(args=None, \*kwargs*)[source]

Bases: abc.ABC

A base client for connecting to the Flow Gateway.

  • Parameters

    • args (Optional[Namespace]) – the Namespace from argparse

    • kwargs – additional parameters that can be accepted by client parser

  • static check_input(inputs=None, \*kwargs*)[source]

    Validate the inputs and print the first request if success.

    • Parameters

      • inputs (Optional[ForwardRef]) – the inputs

      • kwargs – keyword arguments

      Return type

      None

  • property inputs: InputType

    An iterator of bytes, each element represents a Document’s raw content.

    inputs defined in the protobuf

    • Return type

      InputType

      Returns

      inputs

  • property client: jina.helper.T

    Return the client object itself

    • Return type

      ~T

      Returns

      the Client object