Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

jina.clients package

Subpackages

• jina.clients.base package
  • Submodules
    • jina.clients.base.grpc module
      • GRPCBaseClient
    • jina.clients.base.helper module
      • AioHttpClientlet
      • HTTPClientlet
      • 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
  • AsyncGRPCClient
• jina.clients.helper module
  • pprint_routes()
  • callback_exec()
  • callback_exec_on_error()
• jina.clients.http module
  • HTTPClient
  • AsyncHTTPClient
• jina.clients.mixin module
  • MutateMixin
    • MutateMixin.mutate()
  • AsyncMutateMixin
    • AsyncMutateMixin.mutate()
  • 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
  • AsyncWebSocketClient

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, return_responses: Optional[bool] = False, tls: Optional[bool] = False, **kwargs) → Union[AsyncWebSocketClient, WebSocketClient, AsyncGRPCClient, GRPCClient, HTTPClient, AsyncHTTPClient]

Jina Python client.

Parameters

• args (Optional[ForwardRef]) – Namespace args.

• kwargs – Additional arguments.

Return type

Union[ForwardRef, ForwardRef, ForwardRef, ForwardRef, ForwardRef, ForwardRef]

Returns

An instance of GRPCClient or WebSocketClient.