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] [--host] [--port-expose] [--max-message-size]
                   [--proxy] [--batch-size] [--mode {INDEX, SEARCH, TRAIN}]
                   [--top-k] [--mime-type] [--callback-on-body]
                   [--first-request-id] [--first-doc-id  | --random-doc-id]
                   [--timeout-ready] [--filter-by [[...]]] [--skip-dry-run]

grpc and remote arguments

--host

host address of the pea/gateway, by default it is 0.0.0.0.

Default: “0.0.0.0”

--port-expose, --port-grpc

host port of the gateway, “port-grpc” alias will be removed in future versions

Default: 38913

--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

client-specific arguments

--batch-size

the number of documents in each request

Default: 100

--mode

Possible choices: INDEX, SEARCH, TRAIN

the mode of the client and the server

--top-k

top_k results returned in the search mode

Default: 10

--mime-type

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

--callback-on-body

callback function works directly on the request body

Default: False

--first-request-id

the starting number of request id, the consequent request_id will increment by one

Default: 0

--first-doc-id

the starting number of doc_id, the consequent doc_id will increment by one

Default: 0

--random-doc-id

randomize the doc_id, if this is set then first_request_id is ignored

Default: False

--timeout-ready

timeout (ms) of a pea is ready for request, -1 for waiting forever

Default: 10000

--filter-by

field names to search on

--skip-dry-run

skip dry run (connectivity test) before sending every request

Default: False