jina.clients.base package

Submodules

• jina.clients.base.grpc module
  • GRPCBaseClient
    • GRPCBaseClient.aio_tracing_client_interceptors()
    • GRPCBaseClient.aio_tracing_server_interceptors()
    • GRPCBaseClient.check_input()
    • GRPCBaseClient.client
    • GRPCBaseClient.inputs
    • GRPCBaseClient.tracing_client_interceptor()
• jina.clients.base.helper module
  • AioHttpClientlet
    • AioHttpClientlet.send_message()
    • AioHttpClientlet.send_dry_run()
    • AioHttpClientlet.recv_message()
    • AioHttpClientlet.recv_dry_run()
    • AioHttpClientlet.start()
    • AioHttpClientlet.close()
  • HTTPClientlet
    • HTTPClientlet.send_message()
    • HTTPClientlet.send_dry_run()
    • HTTPClientlet.recv_message()
    • HTTPClientlet.recv_dry_run()
    • HTTPClientlet.close()
    • HTTPClientlet.start()
  • WsResponseIter
  • WebsocketClientlet
    • WebsocketClientlet.send_message()
    • WebsocketClientlet.send_dry_run()
    • WebsocketClientlet.send_eoi()
    • WebsocketClientlet.recv_message()
    • WebsocketClientlet.recv_dry_run()
    • WebsocketClientlet.close_message
    • WebsocketClientlet.close()
    • WebsocketClientlet.close_code
    • WebsocketClientlet.start()
• jina.clients.base.http module
  • HTTPBaseClient
    • HTTPBaseClient.aio_tracing_client_interceptors()
    • HTTPBaseClient.aio_tracing_server_interceptors()
    • HTTPBaseClient.check_input()
    • HTTPBaseClient.client
    • HTTPBaseClient.inputs
    • HTTPBaseClient.tracing_client_interceptor()
• jina.clients.base.websocket module
  • WebSocketBaseClient
    • WebSocketBaseClient.aio_tracing_client_interceptors()
    • WebSocketBaseClient.aio_tracing_server_interceptors()
    • WebSocketBaseClient.check_input()
    • WebSocketBaseClient.client
    • WebSocketBaseClient.inputs
    • WebSocketBaseClient.tracing_client_interceptor()

Module contents

Module containing the Base Client for Jina.

class jina.clients.base.BaseClient(args=None, **kwargs)

Bases: InstrumentationMixin, 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)

Validate the inputs and print the first request if success.

Parameters:

• inputs (Optional[InputType]) – 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

aio_tracing_client_interceptors()

Create a gRPC client aio channel interceptor. :rtype: Optional[Sequence[ClientInterceptor]] :returns: An invocation-side list of aio interceptor objects.

aio_tracing_server_interceptors()

Create a gRPC aio server interceptor. :rtype: Optional[Sequence[ServerInterceptor]] :returns: A service-side aio interceptor object.

tracing_client_interceptor()

Return type:

Optional[OpenTelemetryClientInterceptor]

Returns:

a gRPC client interceptor with the global tracing provider.

property client: T

Return the client object itself

Return type:

TypeVar(T)

Returns:

the Client object