jina.clients.base.websocket module#

A module for the websockets-based Client for Jina.

class jina.clients.base.websocket.WebSocketBaseClient(args=None, **kwargs)[source]#

Bases: jina.clients.base.BaseClient

A Websocket Client.

static check_input(inputs=None, **kwargs)#

Validate the inputs and print the first request if success.

Parameters
  • inputs (Optional[InputType]) – the inputs

  • kwargs – keyword arguments

Return type

None

property client: jina.helper.T#

Return the client object itself

Return type

TypeVar(T)

Returns

the Client object

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