0.8.19.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": "hello-world", "options": [{"choices": null, "default": "9e782602-4dda-11eb-89e4-000d3a8e26fa", "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": "/opt/hostedtoolcache/Python/3.7.9/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": null, "default_random": false, "help": "specify the proxy when downloading sample data", "name": "download_proxy", "option_strings": ["--download-proxy"], "required": false, "type": "str"}, {"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 parallel when index and query", "name": "parallel", "option_strings": ["--parallel"], "required": false, "type": "int"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/helloworld.flow.index.yml", "default_random": false, "help": "the yaml path of the index flow", "name": "uses_index", "option_strings": ["--uses-index"], "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": "http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-labels-idx1-ubyte.gz", "default_random": false, "help": "the url of index labels data (should be in idx3-ubyte.gz format)", "name": "index_labels_url", "option_strings": ["--index-labels-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.9/x64/lib/python3.7/site-packages/jina/resources/helloworld.flow.query.yml", "default_random": false, "help": "the yaml path of the query flow", "name": "uses_query", "option_strings": ["--uses-query"], "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": "http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-labels-idx1-ubyte.gz", "default_random": false, "help": "the url of query labels data (should be in idx3-ubyte.gz format)", "name": "query_labels_url", "option_strings": ["--query-labels-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": "pod", "options": [{"choices": null, "default": null, "default_random": false, "help": "the name of this Pea, used to identify the pea/pod and its logs.", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml", "default_random": false, "help": "the yaml config of the logger. note the executor inside will inherit this log config", "name": "log_config", "option_strings": ["--log-config"], "required": false, "type": "str"}, {"choices": null, "default": "9e782613-4dda-11eb-89e4-000d3a8e26fa", "default_random": true, "help": "==SUPPRESS==", "name": "identity", "option_strings": ["--identity"], "required": false, "type": "str"}, {"choices": null, "default": "9e782614-4dda-11eb-89e4-000d3a8e26fa", "default_random": true, "help": "==SUPPRESS==", "name": "log_id", "option_strings": ["--log-id"], "required": false, "type": "str"}, {"choices": null, "default": 54317, "default_random": true, "help": "port for controlling the runtime, 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": 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": null, "default_random": false, "help": "the SSH server through which the tunnel will be created, can actually be a fully specified \"user@server:port\" ssh url.", "name": "ssh_server", "option_strings": ["--ssh-server"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "this specifies a key to be used in ssh login, default None. regular default ssh keys will be used without specifying this argument.", "name": "ssh_keyfile", "option_strings": ["--ssh-keyfile"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "ssh password to the ssh server.", "name": "ssh_password", "option_strings": ["--ssh-password"], "required": false, "type": "str"}, {"choices": null, "default": "_pass", "default_random": false, "help": "the config of the executor, it could be > a YAML file path, > an executor's class name, > a docker image (must start with docker://)> one of \"_pass\", \"_logforward\" > the raw content of YAML config (must starts with \"!\")", "name": "uses", "option_strings": ["--uses"], "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": 35773, "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": 42823, "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": 3, "default_random": false, "help": "max number of retries when socket is conflict", "name": "max_socket_retries", "option_strings": ["--max-socket-retries"], "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 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 `parallel` > 1", "name": "separated_workspace", "option_strings": ["--separated-workspace"], "required": false, "type": "bool"}, {"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": ["NONE", "EXECUTOR", "HANDLE"], "default": "NONE", "default_random": false, "help": "skip strategy on error message.", "name": "skip_on_error", "option_strings": ["--skip-on-error"], "required": false, "type": "method"}, {"choices": null, "default": 0, "default_random": false, "help": "==SUPPRESS==", "name": "num_part", "option_strings": ["--num-part"], "required": false, "type": "int"}, {"choices": null, "default": "BaseExecutor", "default_random": false, "help": "The executor config that is passed to the docker image if a docker image is used in uses. It cannot be another docker image ", "name": "uses_internal", "option_strings": ["--uses-internal"], "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": "0.0.0.0", "default_random": false, "help": "host address of the runtime, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 58783, "default_random": true, "help": "host port of the gateway, \"port-grpc\" alias will be removed in future versions", "name": "port_expose", "option_strings": ["--port-expose", "--port-grpc", "--port-rest"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "the Pea attempts to terminate all of its Runtime child processes/threads on existing. setting it to true basically tell the Pea do not wait on the Runtime when closing", "name": "daemon", "option_strings": ["--daemon"], "required": false, "type": "bool"}, {"choices": ["THREAD", "PROCESS"], "default": "PROCESS", "default_random": false, "help": "the parallel backend of the runtime inside the pea", "name": "runtime_backend", "option_strings": ["--runtime-backend", "--runtime"], "required": false, "type": "method"}, {"choices": ["GRPCRuntime", "RESTRuntime", "ContainerRuntime", "JinadRuntime", "SSHRuntime", "ZEDRuntime"], "default": "ZEDRuntime", "default_random": false, "help": "the runtime class to run inside the pea", "name": "runtime_cls", "option_strings": ["--runtime-cls"], "required": false, "type": "str"}, {"choices": null, "default": 10000, "default_random": false, "help": "timeout (ms) of a pea waits for the runtime to be ready, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "expose the public IP address to remote when necessary, by default it exposesprivate IP address, which only allows accessing under the same network/subnet", "name": "expose_public", "option_strings": ["--expose-public"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "if true then exception stack information to be added to the logging message, useful in debugging", "name": "show_exc_info", "option_strings": ["--show-exc-info"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "==SUPPRESS==", "name": "pea_id", "option_strings": ["--pea-id"], "required": false, "type": "int"}, {"choices": ["SINGLETON", "HEAD", "TAIL", "PARALLEL"], "default": "SINGLETON", "default_random": false, "help": "==SUPPRESS==", "name": "pea_role", "option_strings": ["--pea-role"], "required": false, "type": "method"}, {"choices": null, "default": null, "default_random": false, "help": "the executor used before sending to all parallels, accepted type follows \"--uses\"", "name": "uses_before", "option_strings": ["--uses-before"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the executor used after receiving from all parallels, accepted type follows \"--uses\"", "name": "uses_after", "option_strings": ["--uses-after"], "required": false, "type": "str"}, {"choices": null, "default": 1, "default_random": false, "help": "number of parallel peas in the pod running at the same time, `port_in` and `port_out` will be set to random, and routers will be added automatically when necessary", "name": "parallel", "option_strings": ["--parallel", "--shards"], "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": ["SSH", "JINAD"], "default": "JINAD", "default_random": false, "help": "the way of managing remote runtime", "name": "remote_access", "option_strings": ["--remote-access"], "required": false, "type": "method"}, {"choices": ["PEA", "POD"], "default": "POD", "default_random": false, "help": "the way of managing remote runtime", "name": "remote_type", "option_strings": ["--remote-type"], "required": false, "type": "method"}, {"choices": ["POD", "JOIN", "INSPECT", "GATEWAY", "INSPECT_AUX_PASS", "JOIN_INSPECT"], "default": null, "default_random": false, "help": "==SUPPRESS==", "name": "pod_role", "option_strings": ["--pod-role"], "required": false, "type": "method"}]}, {"name": "flow", "options": [{"choices": null, "default": null, "default_random": false, "help": "a yaml file represents a flow", "name": "uses", "option_strings": ["--uses"], "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.9/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": "9e782625-4dda-11eb-89e4-000d3a8e26fa", "default_random": true, "help": "==SUPPRESS==", "name": "log_id", "option_strings": ["--log-id"], "required": false, "type": "str"}, {"choices": null, "default": "NONE", "default_random": false, "help": "==SUPPRESS==", "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"}, {"choices": ["HANG", "REMOVE", "COLLECT"], "default": "COLLECT", "default_random": false, "help": "strategy on those inspect pods in the flow. if REMOVE is given then all inspect pods are removed when building the flow", "name": "inspect", "option_strings": ["--inspect"], "required": false, "type": "method"}]}, {"name": "gateway", "options": [{"choices": null, "default": "gateway", "default_random": false, "help": "the name of this Pea, used to identify the pea/pod and its logs.", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml", "default_random": false, "help": "the yaml config of the logger. note the executor inside will inherit this log config", "name": "log_config", "option_strings": ["--log-config"], "required": false, "type": "str"}, {"choices": null, "default": "9e782636-4dda-11eb-89e4-000d3a8e26fa", "default_random": true, "help": "==SUPPRESS==", "name": "identity", "option_strings": ["--identity"], "required": false, "type": "str"}, {"choices": null, "default": "9e782637-4dda-11eb-89e4-000d3a8e26fa", "default_random": true, "help": "==SUPPRESS==", "name": "log_id", "option_strings": ["--log-id"], "required": false, "type": "str"}, {"choices": null, "default": 52929, "default_random": true, "help": "port for controlling the runtime, 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": 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": null, "default_random": false, "help": "the SSH server through which the tunnel will be created, can actually be a fully specified \"user@server:port\" ssh url.", "name": "ssh_server", "option_strings": ["--ssh-server"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "this specifies a key to be used in ssh login, default None. regular default ssh keys will be used without specifying this argument.", "name": "ssh_keyfile", "option_strings": ["--ssh-keyfile"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "ssh password to the ssh server.", "name": "ssh_password", "option_strings": ["--ssh-password"], "required": false, "type": "str"}, {"choices": null, "default": "_pass", "default_random": false, "help": "the config of the executor, it could be > a YAML file path, > an executor's class name, > a docker image (must start with docker://)> one of \"_pass\", \"_logforward\" > the raw content of YAML config (must starts with \"!\")", "name": "uses", "option_strings": ["--uses"], "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": 50657, "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": 35369, "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": 3, "default_random": false, "help": "max number of retries when socket is conflict", "name": "max_socket_retries", "option_strings": ["--max-socket-retries"], "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": 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 `parallel` > 1", "name": "separated_workspace", "option_strings": ["--separated-workspace"], "required": false, "type": "bool"}, {"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": ["NONE", "EXECUTOR", "HANDLE"], "default": "NONE", "default_random": false, "help": "skip strategy on error message.", "name": "skip_on_error", "option_strings": ["--skip-on-error"], "required": false, "type": "method"}, {"choices": null, "default": 0, "default_random": false, "help": "==SUPPRESS==", "name": "num_part", "option_strings": ["--num-part"], "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": "use RESTful interface instead of gRPC as the main interface", "name": "restful", "option_strings": ["--restful", "--rest-api"], "required": false, "type": "bool"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address of the runtime, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 44539, "default_random": true, "help": "host port of the gateway, \"port-grpc\" alias will be removed in future versions", "name": "port_expose", "option_strings": ["--port-expose", "--port-grpc", "--port-rest"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "the Pea attempts to terminate all of its Runtime child processes/threads on existing. setting it to true basically tell the Pea do not wait on the Runtime when closing", "name": "daemon", "option_strings": ["--daemon"], "required": false, "type": "bool"}, {"choices": ["THREAD", "PROCESS"], "default": "PROCESS", "default_random": false, "help": "the parallel backend of the runtime inside the pea", "name": "runtime_backend", "option_strings": ["--runtime-backend", "--runtime"], "required": false, "type": "method"}, {"choices": ["GRPCRuntime", "RESTRuntime", "ContainerRuntime", "JinadRuntime", "SSHRuntime", "ZEDRuntime"], "default": "GRPCRuntime", "default_random": false, "help": "the runtime class to run inside the pea", "name": "runtime_cls", "option_strings": ["--runtime-cls"], "required": false, "type": "str"}, {"choices": null, "default": 10000, "default_random": false, "help": "timeout (ms) of a pea waits for the runtime to be ready, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "expose the public IP address to remote when necessary, by default it exposesprivate IP address, which only allows accessing under the same network/subnet", "name": "expose_public", "option_strings": ["--expose-public"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "if true then exception stack information to be added to the logging message, useful in debugging", "name": "show_exc_info", "option_strings": ["--show-exc-info"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "==SUPPRESS==", "name": "pea_id", "option_strings": ["--pea-id"], "required": false, "type": "int"}, {"choices": ["SINGLETON", "HEAD", "TAIL", "PARALLEL"], "default": "SINGLETON", "default_random": false, "help": "==SUPPRESS==", "name": "pea_role", "option_strings": ["--pea-role"], "required": false, "type": "method"}]}, {"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": null, "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": null, "default_random": false, "help": "the markdown file path for all drivers summary", "name": "summary_driver", "option_strings": ["--summary-driver"], "required": false, "type": "str"}]}, {"name": "hub", "options": []}, {"name": "pea", "options": [{"choices": null, "default": null, "default_random": false, "help": "the name of this Pea, used to identify the pea/pod and its logs.", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml", "default_random": false, "help": "the yaml config of the logger. note the executor inside will inherit this log config", "name": "log_config", "option_strings": ["--log-config"], "required": false, "type": "str"}, {"choices": null, "default": "9e782678-4dda-11eb-89e4-000d3a8e26fa", "default_random": true, "help": "==SUPPRESS==", "name": "identity", "option_strings": ["--identity"], "required": false, "type": "str"}, {"choices": null, "default": "9e782679-4dda-11eb-89e4-000d3a8e26fa", "default_random": true, "help": "==SUPPRESS==", "name": "log_id", "option_strings": ["--log-id"], "required": false, "type": "str"}, {"choices": null, "default": 38949, "default_random": true, "help": "port for controlling the runtime, 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": 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": null, "default_random": false, "help": "the SSH server through which the tunnel will be created, can actually be a fully specified \"user@server:port\" ssh url.", "name": "ssh_server", "option_strings": ["--ssh-server"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "this specifies a key to be used in ssh login, default None. regular default ssh keys will be used without specifying this argument.", "name": "ssh_keyfile", "option_strings": ["--ssh-keyfile"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "ssh password to the ssh server.", "name": "ssh_password", "option_strings": ["--ssh-password"], "required": false, "type": "str"}, {"choices": null, "default": "_pass", "default_random": false, "help": "the config of the executor, it could be > a YAML file path, > an executor's class name, > a docker image (must start with docker://)> one of \"_pass\", \"_logforward\" > the raw content of YAML config (must starts with \"!\")", "name": "uses", "option_strings": ["--uses"], "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": 54451, "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": 47323, "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": 3, "default_random": false, "help": "max number of retries when socket is conflict", "name": "max_socket_retries", "option_strings": ["--max-socket-retries"], "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 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 `parallel` > 1", "name": "separated_workspace", "option_strings": ["--separated-workspace"], "required": false, "type": "bool"}, {"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": ["NONE", "EXECUTOR", "HANDLE"], "default": "NONE", "default_random": false, "help": "skip strategy on error message.", "name": "skip_on_error", "option_strings": ["--skip-on-error"], "required": false, "type": "method"}, {"choices": null, "default": 0, "default_random": false, "help": "==SUPPRESS==", "name": "num_part", "option_strings": ["--num-part"], "required": false, "type": "int"}, {"choices": null, "default": "BaseExecutor", "default_random": false, "help": "The executor config that is passed to the docker image if a docker image is used in uses. It cannot be another docker image ", "name": "uses_internal", "option_strings": ["--uses-internal"], "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": "0.0.0.0", "default_random": false, "help": "host address of the runtime, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 46585, "default_random": true, "help": "host port of the gateway, \"port-grpc\" alias will be removed in future versions", "name": "port_expose", "option_strings": ["--port-expose", "--port-grpc", "--port-rest"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "the Pea attempts to terminate all of its Runtime child processes/threads on existing. setting it to true basically tell the Pea do not wait on the Runtime when closing", "name": "daemon", "option_strings": ["--daemon"], "required": false, "type": "bool"}, {"choices": ["THREAD", "PROCESS"], "default": "PROCESS", "default_random": false, "help": "the parallel backend of the runtime inside the pea", "name": "runtime_backend", "option_strings": ["--runtime-backend", "--runtime"], "required": false, "type": "method"}, {"choices": ["GRPCRuntime", "RESTRuntime", "ContainerRuntime", "JinadRuntime", "SSHRuntime", "ZEDRuntime"], "default": "ZEDRuntime", "default_random": false, "help": "the runtime class to run inside the pea", "name": "runtime_cls", "option_strings": ["--runtime-cls"], "required": false, "type": "str"}, {"choices": null, "default": 10000, "default_random": false, "help": "timeout (ms) of a pea waits for the runtime to be ready, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "expose the public IP address to remote when necessary, by default it exposesprivate IP address, which only allows accessing under the same network/subnet", "name": "expose_public", "option_strings": ["--expose-public"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "if true then exception stack information to be added to the logging message, useful in debugging", "name": "show_exc_info", "option_strings": ["--show-exc-info"], "required": false, "type": "bool"}, {"choices": null, "default": -1, "default_random": false, "help": "==SUPPRESS==", "name": "pea_id", "option_strings": ["--pea-id"], "required": false, "type": "int"}, {"choices": ["SINGLETON", "HEAD", "TAIL", "PARALLEL"], "default": "SINGLETON", "default_random": false, "help": "==SUPPRESS==", "name": "pea_role", "option_strings": ["--pea-role"], "required": false, "type": "method"}]}, {"name": "log", "options": [{"choices": null, "default": "(.*@\\d+)\\[", "default_random": false, "help": "the regular expression for grouping logs", "name": "groupby_regex", "option_strings": ["--groupby-regex"], "required": false, "type": "str"}, {"choices": null, "default": 5, "default_random": false, "help": "refresh time interval in seconds, set to -1 to persist all grouped logs", "name": "refresh_time", "option_strings": ["--refresh-time"], "required": false, "type": "int"}]}, {"name": "client", "options": [{"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", "DELETE", "UPDATE", "CONTROL", "TRAIN"], "default": null, "default_random": false, "help": "the mode of the client and the server", "name": "mode", "option_strings": ["--mode"], "required": false, "type": "method"}, {"choices": null, "default": null, "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": null, "default_random": false, "help": "MIME type of the input, useful when input-type is set to BUFFER", "name": "mime_type", "option_strings": ["--mime-type"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "if to continue on all requests when callback function throws an error", "name": "continue_on_error", "option_strings": ["--continue-on-error"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "if to return all results as a list", "name": "return_results", "option_strings": ["--return-results"], "required": false, "type": "bool"}, {"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": "use RESTful interface instead of gRPC as the main interface", "name": "restful", "option_strings": ["--restful", "--rest-api"], "required": false, "type": "bool"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "host address of the runtime, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 49371, "default_random": true, "help": "host port of the gateway, \"port-grpc\" alias will be removed in future versions", "name": "port_expose", "option_strings": ["--port-expose", "--port-grpc", "--port-rest"], "required": false, "type": "int"}]}, {"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.8.19"}