jina client

Note

This command is hidden unless you set JINA_FULL_CLI

Start a Python client that connects to a remote Jina gateway

usage: jina client [-h] [--batch-size]
                   [--mode {INDEX, SEARCH, DELETE, UPDATE ... 2 more choices}]
                   [--top-k] [--mime-type] [--continue-on-error]
                   [--return-results] [--max-message-size] [--proxy]
                   [--prefetch] [--prefetch-on-recv] [--restful] [--host]
                   [--port-expose]

Client arguments

--batch-size

the number of documents in each request

Default: 100

--mode

Possible choices: INDEX, SEARCH, DELETE, UPDATE, CONTROL, TRAIN

the mode of the client and the server

--top-k

top_k results returned in the search mode

--mime-type

MIME type of the input, useful when input-type is set to BUFFER

--continue-on-error

if to continue on all requests when callback function throws an error

Default: False

--return-results

if to return all results as a list

Default: False

GRPC/REST arguments

--max-message-size

maximum send and receive size for gRPC server in bytes, -1 means unlimited

Default: -1

--proxy

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

Default: False

--prefetch

the number of pre-fetched requests from the client

Default: 50

--prefetch-on-recv

the number of additional requests to fetch on every receive

Default: 1

--restful, --rest-api

use RESTful interface instead of gRPC as the main interface

Default: False

Expose arguments

--host

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

Default: “0.0.0.0”

--port-expose

host port exposed to the public

Default: 36665