Vald APIs
Vald provides 6 kinds of API for handling vector with Vald cluster.
Vald provide 2 API interface: gRPC and REST API.
Using gRPC is preferred for better performance.
Vald APIs Overview
The APIs overview tables is here:
| Service | Description | API NAMES | LINK |
|---|---|---|---|
| Insert Service | Insert new vector(s) into the Vald Agent Pods. | Insert StreamInsert MultiInsert | Vald Insert APIs |
| Update Service | Update the exists vector(s) in the Vald Agent Pods. | Update StreamUpdate MultiUpdate | Vald Update APIs |
| Upsert Service | Update the exists vector(s) in the Vald Agent Pods or Insert new vector(s) into the Vald Agent Pods if the vector is not exists. | Upsert StreamUpsert MultiUpdate | Vald Upsert APIs |
| Search Service | Search nearest neighbor vectors using query (vectors or IDs). There are 2 types of Search methods: Search (means ANN Search) and LinearSearch. | Search SearchByID StreamSearch StreamSearchByID MultiSearch MultiSearchByID LinearSearch LinearSearchByID StreamLinearSearch StreamLinearSearchByID MultiLinearSearch MultiLinearSearchByID | Vald Search APIs |
| Remove Service | Remove the exists vector(s) from the Vald Agent Pods. | Remove StreamRemove MultiRemove | Vald Remove APIs |
| Flush Service | Remove the exists all vector(s) from the Vald Agent Pods. | Flush | Vald Flush APIs |
| Object Service | Get information of vector(s) indexed into the Vald Agent Pods. | Exists GetObject StreamGetObject | Vald Object APIs |
linear search services are available in v1.4.0 and later version.
Client Library
Vald provides the public client libraries for some programming languages. If there is no client library for your favorite programming language, please refer to build proto docs to build on yourself.