A Clojure gRPC client library for Vald.
To use this library, one of the following libraries is required.
io.grpc/grpc-okhttp
io.grpc/grpc-netty
io.grpc/grpc-netty-shaded
(require '[vald-client-clj.core :as vald])
;; vald gateway
(def client
(vald/vald-client "localhost" 8081))
;; vald agent
(def agent-client
(vald/agent-client "localhost" 8081))
;; NOTE:
;; gateway and agent have same interfaces.
;; These methods can also be used for agent client.
(-> client
(vald/stream-insert
println
[{:id "meta1"
:vector [0.1 0.2 0.3 0.4 0.5 0.6]}
{:id "meta2"
:vector [0.2 0.2 0.2 0.2 0.2 0.2]}])
(deref))
(-> client
(vald/get-object "meta1"))
(-> client
(vald/stream-search-by-id println {:num 2} ["meta1" "meta2"])
(deref))
(-> client
(vald/search {:num 2} [0.1 0.2 0.3 0.3 0.3 0.4]))
(-> agent-client
(vald/search {:num 2} [0.1 0.2 0.3 0.3 0.3 0.4]))
(vald/close client)
(vald/close agent-client)
valdcli
is a CLI tool built from vald-client-clj.
Fast startup time powered by GraalVM.
Native binaries are available from the latest release.
Docker image is also available.
$ docker run -it vdaas/valdcli --help
$ valdcli --help
Usage: valdcli [OPTIONS] ACTION
Options:
--help show usage
-d, --debug debug mode
-p, --port PORT 8080 Port number
-h, --host HOST localhost Hostname
-a, --agent connect as an agent client
Actions:
exists Check whether ID exists or not.
insert Insert single vector.
search Search single vector.
search-by-id Search vectors using single ID.
update Update single vector.
remove Remove single ID.
get-object Get object info of single ID.
stream-insert Insert multiple vectors.
stream-search Search multiple vectors.
stream-search-by-id Search vectors using multiple IDs.
stream-update Update multiple vectors.
stream-remove Remove multiple IDs.
stream-get-object Get object info of multiple IDs.
create-index Call create-index command. (only for Agent)
save-index Call save-index command. (only for Agent)
create-and-save-index Call create-and-save-index command. (only for Agent)
index-info Fetch index info. (only for Agent)
rand-vec Prints randomized vector.
rand-vecs Prints randomized vectors.
It supports both EDN and JSON format data.
## insert EDN formatted vector
$ valdcli insert abc "[0.1 0.2 0.3 0.4 0.5 0.6]"
## it supports to read stdin
$ echo "[0.1 0.2 0.3 0.4 0.5 0.6]" | valdcli -p 8081 insert abc
## by adding '--json' flag, it reads JSON formatted vector
$ valdcli -h vald.vdaas.org -p 8081 insert --json abc "[0.1, 0.2, 0.3, 0.4, 0.5, 0.6]"
$ valdcli search '[0.1 0.2 0.3 0.4 0.5 0.6]'
## using options
$ valdcli search --num 100 --epsilon 0.02 '[0.1 0.2 0.3 0.4 0.5 0.6]'
## search id 'xyz'
$ valdcli search-by-id --num 100 xyz
$ valdcli stream-insert '[{:id "abc" :vector [0.1 0.2 0.3 0.4 0.5 0.6]} {:id "def" :vector [0.1 0.2 0.3 0.4 0.5 0.6]}]'
$ valdcli stream-search -n 5 '[[0.1 0.2 0.3 0.4 0.5 0.6] [0.1 0.2 0.3 0.4 0.5 0.6] [0.1 0.2 0.3 0.4 0.5 0.6]]'
$ valdcli stream-search-by-id -n 5 '["abc" "def" "xyz"]'
usages of each commands available by running:
$ valdcli exists --help
To use as an agent client, it is recommended to have an alias like:
alias agentcli='valdcli --agent'
Copyright (C) 2020 Vdaas.org Vald team
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Can you improve this documentation?Edit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close