jina.clients package

Subpackages

• jina.clients.base package
  • Submodules
    • jina.clients.base.grpc module
      • GRPCBaseClient
    • jina.clients.base.helper module
      • AioHttpClientlet
      • HTTPClientlet
      • WsResponseIter
      • WebsocketClientlet
    • jina.clients.base.http module
      • HTTPBaseClient
    • jina.clients.base.websocket module
      • WebSocketBaseClient
  • Module contents
    • BaseClient
      • BaseClient.check_input()
      • BaseClient.inputs
      • BaseClient.client
• jina.clients.request package
  • Submodules
    • jina.clients.request.asyncio module
      • request_generator()
    • jina.clients.request.helper module
  • Module contents
    • request_generator()

Submodules

• jina.clients.grpc module
  • GRPCClient
    • GRPCClient.check_input()
    • GRPCClient.client
    • GRPCClient.delete()
    • GRPCClient.dry_run()
    • GRPCClient.index()
    • GRPCClient.inputs
    • GRPCClient.post()
    • GRPCClient.profiling()
    • GRPCClient.search()
    • GRPCClient.update()
  • AsyncGRPCClient
    • AsyncGRPCClient.check_input()
    • AsyncGRPCClient.client
    • AsyncGRPCClient.delete()
    • AsyncGRPCClient.dry_run()
    • AsyncGRPCClient.index()
    • AsyncGRPCClient.inputs
    • AsyncGRPCClient.post()
    • AsyncGRPCClient.search()
    • AsyncGRPCClient.update()
• jina.clients.helper module
  • pprint_routes()
  • callback_exec()
• jina.clients.http module
  • HTTPClient
    • HTTPClient.check_input()
    • HTTPClient.client
    • HTTPClient.delete()
    • HTTPClient.dry_run()
    • HTTPClient.index()
    • HTTPClient.inputs
    • HTTPClient.mutate()
    • HTTPClient.post()
    • HTTPClient.profiling()
    • HTTPClient.search()
    • HTTPClient.update()
  • AsyncHTTPClient
    • AsyncHTTPClient.check_input()
    • AsyncHTTPClient.client
    • AsyncHTTPClient.delete()
    • AsyncHTTPClient.dry_run()
    • AsyncHTTPClient.index()
    • AsyncHTTPClient.inputs
    • AsyncHTTPClient.mutate()
    • AsyncHTTPClient.post()
    • AsyncHTTPClient.profiling()
    • AsyncHTTPClient.search()
    • AsyncHTTPClient.update()
• jina.clients.mixin module
  • MutateMixin
    • MutateMixin.mutate()
  • AsyncMutateMixin
    • AsyncMutateMixin.mutate()
  • HealthCheckMixin
    • HealthCheckMixin.dry_run()
  • AsyncHealthCheckMixin
    • AsyncHealthCheckMixin.dry_run()
  • ProfileMixin
    • ProfileMixin.profiling()
  • AsyncProfileMixin
    • AsyncProfileMixin.profiling()
  • PostMixin
    • PostMixin.post()
    • PostMixin.index()
    • PostMixin.search()
    • PostMixin.update()
    • PostMixin.delete()
  • AsyncPostMixin
    • AsyncPostMixin.post()
    • AsyncPostMixin.index()
    • AsyncPostMixin.search()
    • AsyncPostMixin.update()
    • AsyncPostMixin.delete()
• jina.clients.websocket module
  • WebSocketClient
    • WebSocketClient.check_input()
    • WebSocketClient.client
    • WebSocketClient.delete()
    • WebSocketClient.dry_run()
    • WebSocketClient.index()
    • WebSocketClient.inputs
    • WebSocketClient.post()
    • WebSocketClient.profiling()
    • WebSocketClient.search()
    • WebSocketClient.update()
  • AsyncWebSocketClient
    • AsyncWebSocketClient.check_input()
    • AsyncWebSocketClient.client
    • AsyncWebSocketClient.delete()
    • AsyncWebSocketClient.dry_run()
    • AsyncWebSocketClient.index()
    • AsyncWebSocketClient.inputs
    • AsyncWebSocketClient.post()
    • AsyncWebSocketClient.profiling()
    • AsyncWebSocketClient.search()
    • AsyncWebSocketClient.update()

Module contents

Module wrapping the Client of Jina.

jina.clients.Client(*, asyncio: Optional[bool] = False, host: Optional[str] = '0.0.0.0', port: Optional[int] = None, protocol: Optional[str] = 'GRPC', proxy: Optional[bool] = False, tls: Optional[bool] = False, **kwargs) → Union[AsyncWebSocketClient, WebSocketClient, AsyncGRPCClient, GRPCClient, HTTPClient, AsyncHTTPClient]

Convenience function that returns client instance for given protocol.

EXAMPLE USAGE

from jina import Client
from docarray import Document

# select protocol from 'grpc', 'http', or 'websocket'; default is 'grpc'
# select asyncio True of False; default is False
# select host address to connect to
c = Client(
    protocol='grpc', asyncio=False, host='grpc://my.awesome.flow:1234'
)  # returns GRPCClient instance
c.post(on='/index', inputs=Document(text='hello!'))

Parameters:

• asyncio – If set, then the input and output of this Client work in an asynchronous manner.

• host – The host address of the runtime, by default it is 0.0.0.0.

• port – The port of the Gateway, which the client should connect to.

• protocol – Communication protocol between server and client.

• proxy – If set, respect the http_proxy and https_proxy environment variables. otherwise, it will unset these proxy variables before start. gRPC seems to prefer no proxy

• tls – If set, connect to gateway using tls encryption

Return type:

Union[AsyncWebSocketClient, WebSocketClient, AsyncGRPCClient, GRPCClient, HTTPClient, AsyncHTTPClient]

Returns:

the new Client object