0.1.8.json

{"authors": "dev-team@jina.ai", "description": "Jina is the cloud-native neural search solution powered by state-of-the-art AI and deep learning technology", "docs": "https://docs.jina.ai", "license": "Apache 2.0", "methods": [{"name": "pod", "options": [{"choices": null, "default": null, "default_random": false, "help": "the name of this pea, used to identify the pod and its logs.", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": "9b06f63b93", "default_random": true, "help": "the identity of the sockets, default a random string", "name": "identity", "option_strings": ["--identity"], "required": false, "type": "str"}, {"choices": null, "default": "BaseExecutor", "default_random": false, "help": "the yaml config of the executor, it could be > a YAML file path, > a supported executor's class name, > one of \"_clear\", \"_route\", \"_forward\", \"_logforward\", \"_merge\" > the content of YAML config (must starts with \"!\")", "name": "yaml_path", "option_strings": ["--yaml-path"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the customized python modules need to be imported before loading the executor", "name": "py_modules", "option_strings": ["--py-modules"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the name of the docker image that this pea runs with. it is also served as an indicator of containerization. when this and --yaml-path are both given then the docker image is used and its original yaml configuration is replaced by the given --yaml-path", "name": "image", "option_strings": ["--image"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the entrypoint command overrides the ENTRYPOINT in docker image. when not set then the docker image ENTRYPOINT takes effective.", "name": "entrypoint", "option_strings": ["--entrypoint"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "pull the latest image before running", "name": "pull_latest", "option_strings": ["--pull-latest"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "the path on the host to be mounted inside the container. they will be mounted to the root path, i.e. /user/test/my-workspace will be mounted to /my-workspace inside the container. all volumes are mounted with read-write mode.", "name": "volumes", "option_strings": ["--volumes"], "required": false, "type": "str"}, {"choices": null, "default": 42921, "default_random": true, "help": "port for input data, default a random port between [49152, 65535]", "name": "port_in", "option_strings": ["--port-in"], "required": false, "type": "int"}, {"choices": null, "default": 33435, "default_random": true, "help": "port for output data, default a random port between [49152, 65535]", "name": "port_out", "option_strings": ["--port-out"], "required": false, "type": "int"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address for input, by default it is 0.0.0.0", "name": "host_in", "option_strings": ["--host-in"], "required": false, "type": "str"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address for output, by default it is 0.0.0.0", "name": "host_out", "option_strings": ["--host-out"], "required": false, "type": "str"}, {"choices": ["PULL_BIND", "PULL_CONNECT", "PUSH_BIND", "PUSH_CONNECT", "SUB_BIND", "SUB_CONNECT", "PUB_BIND", "PUB_CONNECT", "PAIR_BIND", "PAIR_CONNECT", "ROUTER_BIND", "DEALER_CONNECT"], "default": "PULL_BIND", "default_random": false, "help": "socket type for input port", "name": "socket_in", "option_strings": ["--socket-in"], "required": false, "type": "method"}, {"choices": ["PULL_BIND", "PULL_CONNECT", "PUSH_BIND", "PUSH_CONNECT", "SUB_BIND", "SUB_CONNECT", "PUB_BIND", "PUB_CONNECT", "PAIR_BIND", "PAIR_CONNECT", "ROUTER_BIND", "DEALER_CONNECT"], "default": "PUSH_BIND", "default_random": false, "help": "socket type for output port", "name": "socket_out", "option_strings": ["--socket-out"], "required": false, "type": "method"}, {"choices": null, "default": 59625, "default_random": true, "help": "port for controlling the pod, default a random port between [49152, 65535]", "name": "port_ctrl", "option_strings": ["--port-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "use ipc protocol for control socket", "name": "ctrl_with_ipc", "option_strings": ["--ctrl-with-ipc"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "timeout (ms) of all requests, -1 for waiting forever", "name": "timeout", "option_strings": ["--timeout"], "required": false, "type": "int"}, {"choices": null, "default": 5000, "default_random": false, "help": "timeout (ms) of the control request, -1 for waiting forever", "name": "timeout_ctrl", "option_strings": ["--timeout-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": 10000, "default_random": false, "help": "timeout (ms) of a pea is ready for request, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}, {"choices": null, "default": 240, "default_random": false, "help": "serialize the model in the pod every n seconds if model changes. -1 means --read-only. ", "name": "dump_interval", "option_strings": ["--dump-interval"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "do not serialize the model when the pod exits", "name": "exit_no_dump", "option_strings": ["--exit-no-dump"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "do not allow the pod to modify the model, dump_interval will be ignored", "name": "read_only", "option_strings": ["--read-only"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "the data and config files are separated for each pea in this pod, only effective when BasePod's `replicas` > 1", "name": "separated_workspace", "option_strings": ["--separated-workspace"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "the id of the storage of this replica, only effective when `separated_workspace=True`", "name": "replica_id", "option_strings": ["--replica-id"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "comparing the jina and proto version of incoming message with local setup, mismatch raise an exception", "name": "check_version", "option_strings": ["--check-version"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "sending raw_bytes and numpy ndarray together within or separately from the protobuf message, the latter often yields a better network efficiency", "name": "array_in_pb", "option_strings": ["--array-in-pb"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "the high watermark that triggers the message compression. message bigger than this HWM (in bytes) will be compressed by lz4 algorithm.set this to -1 to disable this feature.", "name": "compress_hwm", "option_strings": ["--compress-hwm"], "required": false, "type": "int"}, {"choices": null, "default": 1.0, "default_random": false, "help": "the low watermark that enables the sending of a compressed message. compression rate (after_size/before_size) lower than this LWM will be considered as successeful compression, and will be sent. Otherwise, it will send the original message without compression", "name": "compress_lwm", "option_strings": ["--compress-lwm"], "required": false, "type": "float"}, {"choices": null, "default": 1, "default_random": false, "help": "wait until the number of parts of message are all received", "name": "num_part", "option_strings": ["--num-part"], "required": false, "type": "int"}, {"choices": ["REPLICA", "HEAD", "TAIL", "SHARD"], "default": null, "default_random": false, "help": "the role of this pea in a pod", "name": "role", "option_strings": ["--role"], "required": false, "type": "method"}, {"choices": null, "default": -1, "default_random": false, "help": "memory high watermark of this pod in Gigabytes, pod will restart when this is reached. -1 means no restriction", "name": "memory_hwm", "option_strings": ["--memory-hwm"], "required": false, "type": "int"}, {"choices": ["thread", "process"], "default": "process", "default_random": false, "help": "the parallel runtime of the pod", "name": "runtime", "option_strings": ["--runtime"], "required": false, "type": "str"}, {"choices": null, "default": 60, "default_random": false, "help": "label this pea as inactive when it does not process any request after certain time (in second)", "name": "max_idle_time", "option_strings": ["--max-idle-time"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "turn on server-side event logging", "name": "log_sse", "option_strings": ["--log-sse"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "turn on remote logging", "name": "log_remote", "option_strings": ["--log-remote"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "turn on the profiling logger", "name": "log_profile", "option_strings": ["--log-profile"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "turn on to let each logger outputs in its own name (i.e. parent class name as the context), by default it is off so all logs from the same pod will have the same prefix. turn on to help debugging, turn off to have more clear logs and better grouping in dashboard", "name": "log_with_own_name", "option_strings": ["--log-with-own-name"], "required": false, "type": "bool"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address of the pea/gateway, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 49391, "default_random": true, "help": "host port of the grpc gateway", "name": "port_grpc", "option_strings": ["--port-grpc"], "required": false, "type": "int"}, {"choices": null, "default": -1, "default_random": false, "help": "maximum send and receive size for grpc server in bytes, -1 means unlimited", "name": "max_message_size", "option_strings": ["--max-message-size"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "respect the http_proxy and https_proxy environment variables. otherwise, it will unset these proxy variables before start. gRPC seems to prefer --no-proxy", "name": "proxy", "option_strings": ["--proxy"], "required": false, "type": "bool"}, {"choices": null, "default": 1, "default_random": false, "help": "number of parallel peas in the pod running at the same time (i.e. replicas), `port_in` and `port_out` will be set to random, and routers will be added automatically when necessary", "name": "replicas", "option_strings": ["--replicas"], "required": false, "type": "int"}, {"choices": ["ANY", "ALL", "ALL_ASYNC"], "default": "ANY", "default_random": false, "help": "ANY: only one (whoever is idle) replica polls the message; ALL: all workers poll the message (like a broadcast)", "name": "polling", "option_strings": ["--polling"], "required": false, "type": "method"}, {"choices": ["LOAD_BALANCE", "ROUND_ROBIN"], "default": "LOAD_BALANCE", "default_random": false, "help": "the strategy of scheduling workload among peas", "name": "scheduling", "option_strings": ["--scheduling"], "required": false, "type": "method"}, {"choices": null, "default": "_forward", "default_random": false, "help": "the executor used for reducing the result from all replicas, accepted type follows \"--yaml-path\"", "name": "reducing_yaml_path", "option_strings": ["--reducing-yaml-path"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "shutdown this pod when all peas are idle", "name": "shutdown_idle", "option_strings": ["--shutdown-idle"], "required": false, "type": "bool"}]}, {"name": "pea", "options": [{"choices": null, "default": null, "default_random": false, "help": "the name of this pea, used to identify the pod and its logs.", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": "1df0be1cdb", "default_random": true, "help": "the identity of the sockets, default a random string", "name": "identity", "option_strings": ["--identity"], "required": false, "type": "str"}, {"choices": null, "default": "BaseExecutor", "default_random": false, "help": "the yaml config of the executor, it could be > a YAML file path, > a supported executor's class name, > one of \"_clear\", \"_route\", \"_forward\", \"_logforward\", \"_merge\" > the content of YAML config (must starts with \"!\")", "name": "yaml_path", "option_strings": ["--yaml-path"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the customized python modules need to be imported before loading the executor", "name": "py_modules", "option_strings": ["--py-modules"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the name of the docker image that this pea runs with. it is also served as an indicator of containerization. when this and --yaml-path are both given then the docker image is used and its original yaml configuration is replaced by the given --yaml-path", "name": "image", "option_strings": ["--image"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the entrypoint command overrides the ENTRYPOINT in docker image. when not set then the docker image ENTRYPOINT takes effective.", "name": "entrypoint", "option_strings": ["--entrypoint"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "pull the latest image before running", "name": "pull_latest", "option_strings": ["--pull-latest"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "the path on the host to be mounted inside the container. they will be mounted to the root path, i.e. /user/test/my-workspace will be mounted to /my-workspace inside the container. all volumes are mounted with read-write mode.", "name": "volumes", "option_strings": ["--volumes"], "required": false, "type": "str"}, {"choices": null, "default": 56235, "default_random": true, "help": "port for input data, default a random port between [49152, 65535]", "name": "port_in", "option_strings": ["--port-in"], "required": false, "type": "int"}, {"choices": null, "default": 40999, "default_random": true, "help": "port for output data, default a random port between [49152, 65535]", "name": "port_out", "option_strings": ["--port-out"], "required": false, "type": "int"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address for input, by default it is 0.0.0.0", "name": "host_in", "option_strings": ["--host-in"], "required": false, "type": "str"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address for output, by default it is 0.0.0.0", "name": "host_out", "option_strings": ["--host-out"], "required": false, "type": "str"}, {"choices": ["PULL_BIND", "PULL_CONNECT", "PUSH_BIND", "PUSH_CONNECT", "SUB_BIND", "SUB_CONNECT", "PUB_BIND", "PUB_CONNECT", "PAIR_BIND", "PAIR_CONNECT", "ROUTER_BIND", "DEALER_CONNECT"], "default": "PULL_BIND", "default_random": false, "help": "socket type for input port", "name": "socket_in", "option_strings": ["--socket-in"], "required": false, "type": "method"}, {"choices": ["PULL_BIND", "PULL_CONNECT", "PUSH_BIND", "PUSH_CONNECT", "SUB_BIND", "SUB_CONNECT", "PUB_BIND", "PUB_CONNECT", "PAIR_BIND", "PAIR_CONNECT", "ROUTER_BIND", "DEALER_CONNECT"], "default": "PUSH_BIND", "default_random": false, "help": "socket type for output port", "name": "socket_out", "option_strings": ["--socket-out"], "required": false, "type": "method"}, {"choices": null, "default": 53133, "default_random": true, "help": "port for controlling the pod, default a random port between [49152, 65535]", "name": "port_ctrl", "option_strings": ["--port-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "use ipc protocol for control socket", "name": "ctrl_with_ipc", "option_strings": ["--ctrl-with-ipc"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "timeout (ms) of all requests, -1 for waiting forever", "name": "timeout", "option_strings": ["--timeout"], "required": false, "type": "int"}, {"choices": null, "default": 5000, "default_random": false, "help": "timeout (ms) of the control request, -1 for waiting forever", "name": "timeout_ctrl", "option_strings": ["--timeout-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": 10000, "default_random": false, "help": "timeout (ms) of a pea is ready for request, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}, {"choices": null, "default": 240, "default_random": false, "help": "serialize the model in the pod every n seconds if model changes. -1 means --read-only. ", "name": "dump_interval", "option_strings": ["--dump-interval"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "do not serialize the model when the pod exits", "name": "exit_no_dump", "option_strings": ["--exit-no-dump"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "do not allow the pod to modify the model, dump_interval will be ignored", "name": "read_only", "option_strings": ["--read-only"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "the data and config files are separated for each pea in this pod, only effective when BasePod's `replicas` > 1", "name": "separated_workspace", "option_strings": ["--separated-workspace"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "the id of the storage of this replica, only effective when `separated_workspace=True`", "name": "replica_id", "option_strings": ["--replica-id"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "comparing the jina and proto version of incoming message with local setup, mismatch raise an exception", "name": "check_version", "option_strings": ["--check-version"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "sending raw_bytes and numpy ndarray together within or separately from the protobuf message, the latter often yields a better network efficiency", "name": "array_in_pb", "option_strings": ["--array-in-pb"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "the high watermark that triggers the message compression. message bigger than this HWM (in bytes) will be compressed by lz4 algorithm.set this to -1 to disable this feature.", "name": "compress_hwm", "option_strings": ["--compress-hwm"], "required": false, "type": "int"}, {"choices": null, "default": 1.0, "default_random": false, "help": "the low watermark that enables the sending of a compressed message. compression rate (after_size/before_size) lower than this LWM will be considered as successeful compression, and will be sent. Otherwise, it will send the original message without compression", "name": "compress_lwm", "option_strings": ["--compress-lwm"], "required": false, "type": "float"}, {"choices": null, "default": 1, "default_random": false, "help": "wait until the number of parts of message are all received", "name": "num_part", "option_strings": ["--num-part"], "required": false, "type": "int"}, {"choices": ["REPLICA", "HEAD", "TAIL", "SHARD"], "default": null, "default_random": false, "help": "the role of this pea in a pod", "name": "role", "option_strings": ["--role"], "required": false, "type": "method"}, {"choices": null, "default": -1, "default_random": false, "help": "memory high watermark of this pod in Gigabytes, pod will restart when this is reached. -1 means no restriction", "name": "memory_hwm", "option_strings": ["--memory-hwm"], "required": false, "type": "int"}, {"choices": ["thread", "process"], "default": "process", "default_random": false, "help": "the parallel runtime of the pod", "name": "runtime", "option_strings": ["--runtime"], "required": false, "type": "str"}, {"choices": null, "default": 60, "default_random": false, "help": "label this pea as inactive when it does not process any request after certain time (in second)", "name": "max_idle_time", "option_strings": ["--max-idle-time"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "turn on server-side event logging", "name": "log_sse", "option_strings": ["--log-sse"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "turn on remote logging", "name": "log_remote", "option_strings": ["--log-remote"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "turn on the profiling logger", "name": "log_profile", "option_strings": ["--log-profile"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "turn on to let each logger outputs in its own name (i.e. parent class name as the context), by default it is off so all logs from the same pod will have the same prefix. turn on to help debugging, turn off to have more clear logs and better grouping in dashboard", "name": "log_with_own_name", "option_strings": ["--log-with-own-name"], "required": false, "type": "bool"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address of the pea/gateway, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 50187, "default_random": true, "help": "host port of the grpc gateway", "name": "port_grpc", "option_strings": ["--port-grpc"], "required": false, "type": "int"}, {"choices": null, "default": -1, "default_random": false, "help": "maximum send and receive size for grpc server in bytes, -1 means unlimited", "name": "max_message_size", "option_strings": ["--max-message-size"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "respect the http_proxy and https_proxy environment variables. otherwise, it will unset these proxy variables before start. gRPC seems to prefer --no-proxy", "name": "proxy", "option_strings": ["--proxy"], "required": false, "type": "bool"}]}, {"name": "flow", "options": [{"choices": null, "default": null, "default_random": false, "help": "a yaml file represents a flow", "name": "yaml_path", "option_strings": ["--yaml-path"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "start a log server for the dashboard", "name": "logserver", "option_strings": ["--logserver"], "required": false, "type": "bool"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.6/x64/lib/python3.7/site-packages/jina/resources/logserver.default.yml", "default_random": false, "help": "the yaml config of the log server", "name": "logserver_config", "option_strings": ["--logserver-config"], "required": false, "type": "str"}, {"choices": null, "default": "NONE", "default_random": false, "help": "removing redundant routers from the flow. Note, this may change the gateway zmq socket to BIND                             and hence not allow multiple clients connected to the gateway at the same time.", "name": "optimize_level", "option_strings": ["--optimize-level"], "required": false, "type": "method"}, {"choices": ["SHELL_PROC", "SHELL_DOCKER", "DOCKER_SWARM", "K8S"], "default": "SHELL_PROC", "default_random": false, "help": "type of the output", "name": "output_type", "option_strings": ["--output-type"], "required": false, "type": "method"}, {"choices": null, "default": null, "default_random": false, "help": "output path of the flow", "name": "output_path", "option_strings": ["--output-path"], "required": false, "type": "FileType"}]}, {"name": "client", "options": [{"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address of the pea/gateway, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 45407, "default_random": true, "help": "host port of the grpc gateway", "name": "port_grpc", "option_strings": ["--port-grpc"], "required": false, "type": "int"}, {"choices": null, "default": -1, "default_random": false, "help": "maximum send and receive size for grpc server in bytes, -1 means unlimited", "name": "max_message_size", "option_strings": ["--max-message-size"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "respect the http_proxy and https_proxy environment variables. otherwise, it will unset these proxy variables before start. gRPC seems to prefer --no-proxy", "name": "proxy", "option_strings": ["--proxy"], "required": false, "type": "bool"}, {"choices": null, "default": 100, "default_random": false, "help": "the number of documents in each request", "name": "batch_size", "option_strings": ["--batch-size"], "required": false, "type": "int"}, {"choices": ["index", "search", "train"], "default": null, "default_random": false, "help": "the mode of the client and the server", "name": "mode", "option_strings": ["--mode"], "required": true, "type": "str"}, {"choices": null, "default": 10, "default_random": false, "help": "top_k results returned in the search mode", "name": "top_k", "option_strings": ["--top-k"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "if the input data is already in protobuf Document format, or in raw bytes", "name": "in_proto", "option_strings": ["--in-proto"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "callback function works directly on the request body", "name": "callback_on_body", "option_strings": ["--callback-on-body"], "required": false, "type": "bool"}, {"choices": null, "default": 0, "default_random": false, "help": "the starting number of request id, the consequent request_id will increment by one", "name": "first_request_id", "option_strings": ["--first-request-id"], "required": false, "type": "int"}, {"choices": null, "default": 0, "default_random": false, "help": "the starting number of doc_id, the consequent doc_id will increment by one", "name": "first_doc_id", "option_strings": ["--first-doc-id"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "randomize the doc_id, if this is set then `first_request_id` is ignored", "name": "random_doc_id", "option_strings": ["--random-doc-id"], "required": false, "type": "bool"}, {"choices": null, "default": 10000, "default_random": false, "help": "timeout (ms) of a pea is ready for request, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}]}, {"name": "gateway", "options": [{"choices": null, "default": "gateway", "default_random": false, "help": "the name of this pea, used to identify the pod and its logs.", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": "b546b1daea", "default_random": true, "help": "the identity of the sockets, default a random string", "name": "identity", "option_strings": ["--identity"], "required": false, "type": "str"}, {"choices": null, "default": "BaseExecutor", "default_random": false, "help": "the yaml config of the executor, it could be > a YAML file path, > a supported executor's class name, > one of \"_clear\", \"_route\", \"_forward\", \"_logforward\", \"_merge\" > the content of YAML config (must starts with \"!\")", "name": "yaml_path", "option_strings": ["--yaml-path"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the customized python modules need to be imported before loading the executor", "name": "py_modules", "option_strings": ["--py-modules"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the name of the docker image that this pea runs with. it is also served as an indicator of containerization. when this and --yaml-path are both given then the docker image is used and its original yaml configuration is replaced by the given --yaml-path", "name": "image", "option_strings": ["--image"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the entrypoint command overrides the ENTRYPOINT in docker image. when not set then the docker image ENTRYPOINT takes effective.", "name": "entrypoint", "option_strings": ["--entrypoint"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "pull the latest image before running", "name": "pull_latest", "option_strings": ["--pull-latest"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "the path on the host to be mounted inside the container. they will be mounted to the root path, i.e. /user/test/my-workspace will be mounted to /my-workspace inside the container. all volumes are mounted with read-write mode.", "name": "volumes", "option_strings": ["--volumes"], "required": false, "type": "str"}, {"choices": null, "default": 38629, "default_random": true, "help": "port for input data, default a random port between [49152, 65535]", "name": "port_in", "option_strings": ["--port-in"], "required": false, "type": "int"}, {"choices": null, "default": 46941, "default_random": true, "help": "port for output data, default a random port between [49152, 65535]", "name": "port_out", "option_strings": ["--port-out"], "required": false, "type": "int"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address for input, by default it is 0.0.0.0", "name": "host_in", "option_strings": ["--host-in"], "required": false, "type": "str"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address for output, by default it is 0.0.0.0", "name": "host_out", "option_strings": ["--host-out"], "required": false, "type": "str"}, {"choices": ["PULL_BIND", "PULL_CONNECT", "PUSH_BIND", "PUSH_CONNECT", "SUB_BIND", "SUB_CONNECT", "PUB_BIND", "PUB_CONNECT", "PAIR_BIND", "PAIR_CONNECT", "ROUTER_BIND", "DEALER_CONNECT"], "default": "PULL_CONNECT", "default_random": false, "help": "socket type for input port", "name": "socket_in", "option_strings": ["--socket-in"], "required": false, "type": "method"}, {"choices": ["PULL_BIND", "PULL_CONNECT", "PUSH_BIND", "PUSH_CONNECT", "SUB_BIND", "SUB_CONNECT", "PUB_BIND", "PUB_CONNECT", "PAIR_BIND", "PAIR_CONNECT", "ROUTER_BIND", "DEALER_CONNECT"], "default": "PUSH_CONNECT", "default_random": false, "help": "socket type for output port", "name": "socket_out", "option_strings": ["--socket-out"], "required": false, "type": "method"}, {"choices": null, "default": 49563, "default_random": true, "help": "port for controlling the pod, default a random port between [49152, 65535]", "name": "port_ctrl", "option_strings": ["--port-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": true, "default_random": false, "help": "use ipc protocol for control socket", "name": "ctrl_with_ipc", "option_strings": ["--ctrl-with-ipc"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "timeout (ms) of all requests, -1 for waiting forever", "name": "timeout", "option_strings": ["--timeout"], "required": false, "type": "int"}, {"choices": null, "default": 5000, "default_random": false, "help": "timeout (ms) of the control request, -1 for waiting forever", "name": "timeout_ctrl", "option_strings": ["--timeout-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": 10000, "default_random": false, "help": "timeout (ms) of a pea is ready for request, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}, {"choices": null, "default": 240, "default_random": false, "help": "serialize the model in the pod every n seconds if model changes. -1 means --read-only. ", "name": "dump_interval", "option_strings": ["--dump-interval"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "do not serialize the model when the pod exits", "name": "exit_no_dump", "option_strings": ["--exit-no-dump"], "required": false, "type": "bool"}, {"choices": null, "default": true, "default_random": false, "help": "do not allow the pod to modify the model, dump_interval will be ignored", "name": "read_only", "option_strings": ["--read-only"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "the data and config files are separated for each pea in this pod, only effective when BasePod's `replicas` > 1", "name": "separated_workspace", "option_strings": ["--separated-workspace"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "the id of the storage of this replica, only effective when `separated_workspace=True`", "name": "replica_id", "option_strings": ["--replica-id"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "comparing the jina and proto version of incoming message with local setup, mismatch raise an exception", "name": "check_version", "option_strings": ["--check-version"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "sending raw_bytes and numpy ndarray together within or separately from the protobuf message, the latter often yields a better network efficiency", "name": "array_in_pb", "option_strings": ["--array-in-pb"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "the high watermark that triggers the message compression. message bigger than this HWM (in bytes) will be compressed by lz4 algorithm.set this to -1 to disable this feature.", "name": "compress_hwm", "option_strings": ["--compress-hwm"], "required": false, "type": "int"}, {"choices": null, "default": 1.0, "default_random": false, "help": "the low watermark that enables the sending of a compressed message. compression rate (after_size/before_size) lower than this LWM will be considered as successeful compression, and will be sent. Otherwise, it will send the original message without compression", "name": "compress_lwm", "option_strings": ["--compress-lwm"], "required": false, "type": "float"}, {"choices": null, "default": 1, "default_random": false, "help": "wait until the number of parts of message are all received", "name": "num_part", "option_strings": ["--num-part"], "required": false, "type": "int"}, {"choices": ["REPLICA", "HEAD", "TAIL", "SHARD"], "default": null, "default_random": false, "help": "the role of this pea in a pod", "name": "role", "option_strings": ["--role"], "required": false, "type": "method"}, {"choices": null, "default": -1, "default_random": false, "help": "memory high watermark of this pod in Gigabytes, pod will restart when this is reached. -1 means no restriction", "name": "memory_hwm", "option_strings": ["--memory-hwm"], "required": false, "type": "int"}, {"choices": ["thread", "process"], "default": "process", "default_random": false, "help": "the parallel runtime of the pod", "name": "runtime", "option_strings": ["--runtime"], "required": false, "type": "str"}, {"choices": null, "default": 60, "default_random": false, "help": "label this pea as inactive when it does not process any request after certain time (in second)", "name": "max_idle_time", "option_strings": ["--max-idle-time"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "turn on server-side event logging", "name": "log_sse", "option_strings": ["--log-sse"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "turn on remote logging", "name": "log_remote", "option_strings": ["--log-remote"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "turn on the profiling logger", "name": "log_profile", "option_strings": ["--log-profile"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "turn on to let each logger outputs in its own name (i.e. parent class name as the context), by default it is off so all logs from the same pod will have the same prefix. turn on to help debugging, turn off to have more clear logs and better grouping in dashboard", "name": "log_with_own_name", "option_strings": ["--log-with-own-name"], "required": false, "type": "bool"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address of the pea/gateway, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 51427, "default_random": true, "help": "host port of the grpc gateway", "name": "port_grpc", "option_strings": ["--port-grpc"], "required": false, "type": "int"}, {"choices": null, "default": -1, "default_random": false, "help": "maximum send and receive size for grpc server in bytes, -1 means unlimited", "name": "max_message_size", "option_strings": ["--max-message-size"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "respect the http_proxy and https_proxy environment variables. otherwise, it will unset these proxy variables before start. gRPC seems to prefer --no-proxy", "name": "proxy", "option_strings": ["--proxy"], "required": false, "type": "bool"}, {"choices": null, "default": 50, "default_random": false, "help": "the number of pre-fetched requests from the client", "name": "prefetch", "option_strings": ["--prefetch"], "required": false, "type": "int"}, {"choices": null, "default": 1, "default_random": false, "help": "the number of additional requests to fetch on every receive", "name": "prefetch_on_recv", "option_strings": ["--prefetch-on-recv"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "accept the spawn requests sent from other remote Jina", "name": "allow_spawn", "option_strings": ["--allow-spawn"], "required": false, "type": "bool"}]}, {"name": "hello-world", "options": [{"choices": null, "default": "95e4e1825f", "default_random": true, "help": "the workdir for hello-world demo, all data, indices, shards and outputs will be saved there", "name": "workdir", "option_strings": ["--workdir"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "start a log server for the dashboard", "name": "logserver", "option_strings": ["--logserver"], "required": false, "type": "bool"}, {"choices": null, "default": 2, "default_random": false, "help": "number of shards when index and query", "name": "shards", "option_strings": ["--shards"], "required": false, "type": "int"}, {"choices": null, "default": 2, "default_random": false, "help": "number of replicas when index and query", "name": "replicas", "option_strings": ["--replicas"], "required": false, "type": "int"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.6/x64/lib/python3.7/site-packages/jina/resources/helloworld.flow.index.yml", "default_random": false, "help": "the yaml path of the index flow", "name": "index_yaml_path", "option_strings": ["--index-yaml-path"], "required": false, "type": "str"}, {"choices": null, "default": "http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-images-idx3-ubyte.gz", "default_random": false, "help": "the url of index data (should be in idx3-ubyte.gz format)", "name": "index_data_url", "option_strings": ["--index-data-url"], "required": false, "type": "str"}, {"choices": null, "default": 1024, "default_random": false, "help": "the batch size in indexing", "name": "index_batch_size", "option_strings": ["--index-batch-size"], "required": false, "type": "int"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.6/x64/lib/python3.7/site-packages/jina/resources/helloworld.flow.query.yml", "default_random": false, "help": "the yaml path of the query flow", "name": "query_yaml_path", "option_strings": ["--query-yaml-path"], "required": false, "type": "str"}, {"choices": null, "default": "http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-images-idx3-ubyte.gz", "default_random": false, "help": "the url of query data (should be in idx3-ubyte.gz format)", "name": "query_data_url", "option_strings": ["--query-data-url"], "required": false, "type": "str"}, {"choices": null, "default": 32, "default_random": false, "help": "the batch size in searching", "name": "query_batch_size", "option_strings": ["--query-batch-size"], "required": false, "type": "int"}, {"choices": null, "default": 128, "default_random": false, "help": "number of queries to visualize", "name": "num_query", "option_strings": ["--num-query"], "required": false, "type": "int"}, {"choices": null, "default": 50, "default_random": false, "help": "top-k results to retrieve and visualize", "name": "top_k", "option_strings": ["--top-k"], "required": false, "type": "int"}]}, {"name": "ping", "options": [{"choices": null, "default": null, "default_random": false, "help": "host address of the target pod/pea, e.g. 0.0.0.0", "name": "host", "option_strings": [], "required": true, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the control port of the target pod/pea", "name": "port", "option_strings": [], "required": true, "type": "int"}, {"choices": null, "default": 3000, "default_random": false, "help": "timeout (ms) of one check, -1 for waiting forever", "name": "timeout", "option_strings": ["--timeout"], "required": false, "type": "int"}, {"choices": null, "default": 3, "default_random": false, "help": "max number of tried health checks before exit 1", "name": "retries", "option_strings": ["--retries"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "print the response when received", "name": "print_response", "option_strings": ["--print-response"], "required": false, "type": "bool"}]}, {"name": "check", "options": [{"choices": null, "default": "./docs/chapters/all_exec.md", "default_random": false, "help": "the markdown file path for all executors summary", "name": "summary_exec", "option_strings": ["--summary-exec"], "required": false, "type": "str"}, {"choices": null, "default": "./docs/chapters/all_driver.md", "default_random": false, "help": "the markdown file path for all drivers summary", "name": "summary_driver", "option_strings": ["--summary-driver"], "required": false, "type": "str"}]}, {"name": "export-api", "options": [{"choices": null, "default": null, "default_random": false, "help": "the YAML file path for storing the exported API", "name": "yaml_path", "option_strings": ["--yaml-path"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the JSON file path for storing the exported API", "name": "json_path", "option_strings": ["--json-path"], "required": false, "type": "str"}]}], "name": "Jina", "revision": null, "source": "https://github.com/jina-ai/jina/tree/master", "url": "https://jina.ai", "vendor": "Jina AI Limited", "version": "0.1.8"}