diff --git a/Makefile b/Makefile index 326e93a2b5..53bd18ef09 100644 --- a/Makefile +++ b/Makefile @@ -153,8 +153,10 @@ PROTOS_V1 := $(eval PROTOS_V1 := $(filter apis/proto/v1/%.proto,$(PROTOS)))$(PRO PBGOS = $(PROTOS:apis/proto/%.proto=apis/grpc/%.pb.go) SWAGGERS = $(PROTOS:apis/proto/%.proto=apis/swagger/%.swagger.json) PBDOCS = $(ROOTDIR)/apis/docs/v1/docs.md -PROTO_APIS := $(eval PROTO_APIS := $(filter $(ROOTDIR)/apis/proto/v1/vald/%.proto,$(PROTOS)))$(PROTO_APIS) -PROTO_API_DOCS := $(PROTO_APIS:$(ROOTDIR)/apis/proto/v1/vald/%.proto=$(ROOTDIR)/apis/docs/v1/%.md) +PROTO_VALD_APIS := $(eval PROTO_VALD_APIS := $(filter $(ROOTDIR)/apis/proto/v1/vald/%.proto,$(PROTOS)))$(PROTO_VALD_APIS) +PROTO_VALD_API_DOCS := $(PROTO_VALD_APIS:$(ROOTDIR)/apis/proto/v1/vald/%.proto=$(ROOTDIR)/apis/docs/v1/%.md) +PROTO_MIRROR_APIS := $(eval PROTO_MIRROR_APIS := $(filter $(ROOTDIR)/apis/proto/v1/mirror/%.proto,$(PROTOS)))$(PROTO_MIRROR_APIS) +PROTO_MIRROR_API_DOCS := $(PROTO_MIRROR_APIS:$(ROOTDIR)/apis/proto/v1/mirror/%.proto=$(ROOTDIR)/apis/docs/v1/%.md) LDFLAGS = -static -fPIC -pthread -std=gnu++23 -lstdc++ -lm -z relro -z now -flto=auto -march=native -mtune=native -fno-plt -Ofast -fvisibility=hidden -ffp-contract=fast -fomit-frame-pointer -fmerge-all-constants -funroll-loops -falign-functions=32 -ffunction-sections -fdata-sections diff --git a/Makefile.d/functions.mk b/Makefile.d/functions.mk index c44aa8d34c..0cd34a80a7 100644 --- a/Makefile.d/functions.mk +++ b/Makefile.d/functions.mk @@ -463,3 +463,11 @@ define gen-deadlink-checker $$BIN_PATH -path $3 -ignore-path $4 -format $5 $1; \ rm -rf $$BIN_PATH endef + +define gen-api-document + buf generate --template=apis/docs/buf.gen.tmpl.yaml --path $2 + cat apis/docs/v1/payload.md.tmpl apis/docs/v1/_doc.md.tmpl > apis/docs/v1/doc.md.tmpl; \ + buf generate --template=apis/docs/buf.gen.doc.yaml --path $2; \ + mv $(ROOTDIR)/apis/docs/v1/doc.md $1; \ + rm apis/docs/v1/*doc.md.tmpl +endef diff --git a/Makefile.d/proto.mk b/Makefile.d/proto.mk index d93232d80e..5ca6902ea6 100644 --- a/Makefile.d/proto.mk +++ b/Makefile.d/proto.mk @@ -66,23 +66,22 @@ proto/gen/code: \ proto/gen/api/docs: \ proto/gen/api/docs/payload \ - $(PROTO_API_DOCS) + $(PROTO_VALD_API_DOCS) \ + $(PROTO_MIRROR_API_DOCS) proto/gen/api/docs/payload: $(ROOTDIR)/apis/docs/v1/payload.md.tmpl $(ROOTDIR)/apis/docs/v1/payload.md.tmpl: $(ROOTDIR)/apis/proto/v1/payload/payload.proto $(ROOTDIR)/apis/docs/v1/payload.tmpl - @$(call green, "generating payload v1...") - buf generate --template=apis/docs/buf.gen.payload.yaml --path apis/proto/v1/payload/payload.proto + @$(call green,"generating payload v1...") + buf generate --template=apis/docs/buf.gen.payload.yaml $(ROOTDIR)/apis/docs/v1/%.md: $(ROOTDIR)/apis/proto/v1/vald/%.proto $(ROOTDIR)/apis/docs/v1/payload.md.tmpl $(ROOTDIR)/apis/docs/v1/doc.tmpl - @$(call green, "generating documents for API v1...") - buf generate --template=apis/docs/buf.gen.tmpl.yaml --path $(subst $(ROOTDIR)/,,$<) - cat apis/docs/v1/payload.md.tmpl apis/docs/v1/_doc.md.tmpl > apis/docs/v1/doc.md.tmpl - @sleep 1 - buf generate --template=apis/docs/buf.gen.doc.yaml - @sleep 1 - mv $(ROOTDIR)/apis/docs/v1/doc.md $@ - rm apis/docs/v1/*doc.md.tmpl + @$(call green,"generating documents for API v1...") + @$(call gen-api-document,$@,$(subst $(ROOTDIR)/,,$<)) + +$(ROOTDIR)/apis/docs/v1/mirror.md: $(ROOTDIR)/apis/proto/v1/mirror/mirror.proto $(ROOTDIR)/apis/docs/v1/payload.md.tmpl $(ROOTDIR)/apis/docs/v1/doc.tmpl + @$(call green,"generating documents for API v1...") + @$(call gen-api-document,$@,$(subst $(ROOTDIR)/,,$<)) proto/replace: find $(ROOTDIR)/apis/grpc/* -name '*.go' | xargs -P$(CORES) sed -i -E "s%google.golang.org/grpc/codes%$(GOPKG)/internal/net/grpc/codes%g" diff --git a/apis/docs/buf.gen.payload.yaml b/apis/docs/buf.gen.payload.yaml index 5d37757323..8dd7f45c7c 100644 --- a/apis/docs/buf.gen.payload.yaml +++ b/apis/docs/buf.gen.payload.yaml @@ -25,3 +25,5 @@ plugins: - local: protoc-gen-doc out: apis/docs/v1 opt: apis/docs/v1/payload.tmpl,payload.md.tmpl +inputs: + - proto_file: apis/proto/v1/payload/payload.proto diff --git a/apis/docs/v1/doc.tmpl b/apis/docs/v1/doc.tmpl index 04bdb8f088..243c951243 100644 --- a/apis/docs/v1/doc.tmpl +++ b/apis/docs/v1/doc.tmpl @@ -37,9 +37,7 @@ service {{.Name}} { ```rpc {{ printf "{{- template \"scheme:%s\" }}\n" .RequestFullType }} ``` - -{{ printf "{{- template \"field:%s\" }}\n" .RequestFullType }} - +{{ printf "{{ template \"field:%s\" }}" .RequestFullType }} ### Output - the scheme of `{{ .ResponseFullType }}` @@ -47,10 +45,8 @@ service {{.Name}} { ```rpc {{ printf "{{- template \"scheme:%s\" }}\n" .ResponseFullType }} ``` - -{{ printf "{{ template \"field:%s\" }}\n" .ResponseFullType }} - -{{- if hasKey $descs "Status Code" }} +{{ printf "{{ template \"field:%s\" }}" .ResponseFullType }} +{{ if hasKey $descs "Status Code" }} ### Status Code | code | description | @@ -58,11 +54,8 @@ service {{.Name}} { {{ pluck "Status Code" $descs | first | trim }} Please refer to [Response Status Code](../status.md) for more details. - {{ end }} - -{{- if hasKey $descs "Troubleshooting" }} - +{{ if hasKey $descs "Troubleshooting" }} ### Troubleshooting {{ pluck "Troubleshooting" $descs | first | trim }} diff --git a/apis/docs/v1/filter.md b/apis/docs/v1/filter.md index 3a2d54fbdd..53b45a3a96 100644 --- a/apis/docs/v1/filter.md +++ b/apis/docs/v1/filter.md @@ -63,7 +63,7 @@ SearchObject RPC is the method to search object(s) similar to request object. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -75,39 +75,39 @@ SearchObject RPC is the method to search object(s) similar to request object. - Search.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | bytes | | The binary object to be searched. | - | config | Search.Config | | The configuration of the search request. | - | vectorizer | Filter.Target | | Filter configuration. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | bytes | | The binary object to be searched. | + | config | Search.Config | | The configuration of the search request. | + | vectorizer | Filter.Target | | Filter configuration. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | ### Output @@ -129,17 +129,17 @@ SearchObject RPC is the method to search object(s) similar to request object. - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -198,7 +198,7 @@ Each Search request and response are independent. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -210,45 +210,45 @@ Each Search request and response are independent. - Search.MultiObjectRequest - | field | type | label | description | - | :------: | :------------------- | :------- | :-------------------------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Search.ObjectRequest | repeated | Represent the multiple search by binary object request content. | - Search.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | bytes | | The binary object to be searched. | - | config | Search.Config | | The configuration of the search request. | - | vectorizer | Filter.Target | | Filter configuration. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | bytes | | The binary object to be searched. | + | config | Search.Config | | The configuration of the search request. | + | vectorizer | Filter.Target | | Filter configuration. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | ### Output @@ -274,23 +274,23 @@ Each Search request and response are independent. - Search.Responses - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | responses | Search.Response | repeated | Represent the multiple search response content. | - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -348,7 +348,7 @@ Please be careful that the size of the request exceeds the limit. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -360,39 +360,39 @@ Please be careful that the size of the request exceeds the limit. - Search.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | bytes | | The binary object to be searched. | - | config | Search.Config | | The configuration of the search request. | - | vectorizer | Filter.Target | | Filter configuration. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | bytes | | The binary object to be searched. | + | config | Search.Config | | The configuration of the search request. | + | vectorizer | Filter.Target | | Filter configuration. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | ### Output @@ -419,24 +419,24 @@ Please be careful that the size of the request exceeds the limit. - Search.StreamResponse - | field | type | label | description | - | :------: | :---------------- | :---- | :----------------------------- | - | response | Search.Response | | Represent the search response. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | response | Search.Response | | Represent the search response. | + | status | google.rpc.Status | | The RPC error status. | - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -490,40 +490,39 @@ InsertObject RPC is the method to insert object through Vald Filter Gateway. - Insert.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | Object.Blob | | The binary object to be inserted. | - | config | Insert.Config | | The configuration of the insert request. | - | vectorizer | Filter.Target | | Filter configurations. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | Object.Blob | | The binary object to be inserted. | + | config | Insert.Config | | The configuration of the insert request. | + | vectorizer | Filter.Target | | Filter configurations. | - Object.Blob - | field | type | label | description | - | :----: | :----- | :---- | :----------------- | - | id | string | | The object ID. | - | object | bytes | | The binary object. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The object ID. | + | object | bytes | | The binary object. | - Insert.Config - | field | type | label | description | - | :---------------------: | :------------ | :---- | :-------------------------------------------------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | - | filters | Filter.Config | | Filter configurations. | - | timestamp | int64 | | Insert timestamp. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | + | filters | Filter.Config | | Filter configurations. | + | timestamp | int64 | | Insert timestamp. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - ### Output - the scheme of `payload.v1.Object.Location` @@ -539,11 +538,11 @@ InsertObject RPC is the method to insert object through Vald Filter Gateway. - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -601,40 +600,39 @@ It's the recommended method to insert a large number of objects. - Insert.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | Object.Blob | | The binary object to be inserted. | - | config | Insert.Config | | The configuration of the insert request. | - | vectorizer | Filter.Target | | Filter configurations. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | Object.Blob | | The binary object to be inserted. | + | config | Insert.Config | | The configuration of the insert request. | + | vectorizer | Filter.Target | | Filter configurations. | - Object.Blob - | field | type | label | description | - | :----: | :----- | :---- | :----------------- | - | id | string | | The object ID. | - | object | bytes | | The binary object. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The object ID. | + | object | bytes | | The binary object. | - Insert.Config - | field | type | label | description | - | :---------------------: | :------------ | :---- | :-------------------------------------------------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | - | filters | Filter.Config | | Filter configurations. | - | timestamp | int64 | | Insert timestamp. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | + | filters | Filter.Config | | Filter configurations. | + | timestamp | int64 | | Insert timestamp. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - ### Output - the scheme of `payload.v1.Object.StreamLocation` @@ -655,18 +653,18 @@ It's the recommended method to insert a large number of objects. - Object.StreamLocation - | field | type | label | description | - | :------: | :---------------- | :---- | :-------------------- | - | location | Object.Location | | The vector location. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | location | Object.Location | | The vector location. | + | status | google.rpc.Status | | The RPC error status. | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -724,46 +722,45 @@ MultiInsertObject RPC is the method to add multiple new objects in **1** request - Insert.MultiObjectRequest - | field | type | label | description | - | :------: | :------------------- | :------- | :------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Insert.ObjectRequest | repeated | Represent multiple insert by object content. | - Insert.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | Object.Blob | | The binary object to be inserted. | - | config | Insert.Config | | The configuration of the insert request. | - | vectorizer | Filter.Target | | Filter configurations. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | Object.Blob | | The binary object to be inserted. | + | config | Insert.Config | | The configuration of the insert request. | + | vectorizer | Filter.Target | | Filter configurations. | - Object.Blob - | field | type | label | description | - | :----: | :----- | :---- | :----------------- | - | id | string | | The object ID. | - | object | bytes | | The binary object. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The object ID. | + | object | bytes | | The binary object. | - Insert.Config - | field | type | label | description | - | :---------------------: | :------------ | :---- | :-------------------------------------------------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | - | filters | Filter.Config | | Filter configurations. | - | timestamp | int64 | | Insert timestamp. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | + | filters | Filter.Config | | Filter configurations. | + | timestamp | int64 | | Insert timestamp. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - ### Output - the scheme of `payload.v1.Object.Locations` @@ -783,17 +780,17 @@ MultiInsertObject RPC is the method to add multiple new objects in **1** request - Object.Locations - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------- | - | locations | Object.Location | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | locations | Object.Location | repeated | | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -848,43 +845,41 @@ UpdateObject RPC is the method to update a single vector. - Update.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | Object.Blob | | The binary object to be updated. | - | config | Update.Config | | The configuration of the update request. | - | vectorizer | Filter.Target | | Filter target. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | Object.Blob | | The binary object to be updated. | + | config | Update.Config | | The configuration of the update request. | + | vectorizer | Filter.Target | | Filter target. | - Object.Blob - | field | type | label | description | - | :----: | :----- | :---- | :----------------- | - | id | string | | The object ID. | - | object | bytes | | The binary object. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The object ID. | + | object | bytes | | The binary object. | - Update.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Update timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Update timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - ### Output - the scheme of `payload.v1.Object.Location` @@ -900,11 +895,11 @@ UpdateObject RPC is the method to update a single vector. - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -962,43 +957,41 @@ It's the recommended method to update the large amount of objects. - Update.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | Object.Blob | | The binary object to be updated. | - | config | Update.Config | | The configuration of the update request. | - | vectorizer | Filter.Target | | Filter target. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | Object.Blob | | The binary object to be updated. | + | config | Update.Config | | The configuration of the update request. | + | vectorizer | Filter.Target | | Filter target. | - Object.Blob - | field | type | label | description | - | :----: | :----- | :---- | :----------------- | - | id | string | | The object ID. | - | object | bytes | | The binary object. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The object ID. | + | object | bytes | | The binary object. | - Update.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Update timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Update timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - ### Output - the scheme of `payload.v1.Object.StreamLocation` @@ -1019,18 +1012,18 @@ It's the recommended method to update the large amount of objects. - Object.StreamLocation - | field | type | label | description | - | :------: | :---------------- | :---- | :-------------------- | - | location | Object.Location | | The vector location. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | location | Object.Location | | The vector location. | + | status | google.rpc.Status | | The RPC error status. | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -1094,49 +1087,47 @@ Please be careful that the size of the request exceed the limit. - Update.MultiObjectRequest - | field | type | label | description | - | :------: | :------------------- | :------- | :---------------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Update.ObjectRequest | repeated | Represent the multiple update object request content. | - Update.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | Object.Blob | | The binary object to be updated. | - | config | Update.Config | | The configuration of the update request. | - | vectorizer | Filter.Target | | Filter target. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | Object.Blob | | The binary object to be updated. | + | config | Update.Config | | The configuration of the update request. | + | vectorizer | Filter.Target | | Filter target. | - Object.Blob - | field | type | label | description | - | :----: | :----- | :---- | :----------------- | - | id | string | | The object ID. | - | object | bytes | | The binary object. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The object ID. | + | object | bytes | | The binary object. | - Update.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Update timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Update timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - ### Output - the scheme of `payload.v1.Object.Locations` @@ -1156,17 +1147,17 @@ Please be careful that the size of the request exceed the limit. - Object.Locations - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------- | - | locations | Object.Location | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | locations | Object.Location | repeated | | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -1221,43 +1212,41 @@ UpsertObject RPC is the method to update a single object and add a new single ob - Upsert.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | Object.Blob | | The binary object to be upserted. | - | config | Upsert.Config | | The configuration of the upsert request. | - | vectorizer | Filter.Target | | Filter target. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | Object.Blob | | The binary object to be upserted. | + | config | Upsert.Config | | The configuration of the upsert request. | + | vectorizer | Filter.Target | | Filter target. | - Object.Blob - | field | type | label | description | - | :----: | :----- | :---- | :----------------- | - | id | string | | The object ID. | - | object | bytes | | The binary object. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The object ID. | + | object | bytes | | The binary object. | - Upsert.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Upsert timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Upsert timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - ### Output - the scheme of `payload.v1.Object.Location` @@ -1273,11 +1262,11 @@ UpsertObject RPC is the method to update a single object and add a new single ob - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -1332,43 +1321,41 @@ UpsertObject RPC is the method to update a single object and add a new single ob - Upsert.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | Object.Blob | | The binary object to be upserted. | - | config | Upsert.Config | | The configuration of the upsert request. | - | vectorizer | Filter.Target | | Filter target. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | Object.Blob | | The binary object to be upserted. | + | config | Upsert.Config | | The configuration of the upsert request. | + | vectorizer | Filter.Target | | Filter target. | - Object.Blob - | field | type | label | description | - | :----: | :----- | :---- | :----------------- | - | id | string | | The object ID. | - | object | bytes | | The binary object. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The object ID. | + | object | bytes | | The binary object. | - Upsert.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Upsert timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Upsert timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - ### Output - the scheme of `payload.v1.Object.StreamLocation` @@ -1389,18 +1376,18 @@ UpsertObject RPC is the method to update a single object and add a new single ob - Object.StreamLocation - | field | type | label | description | - | :------: | :---------------- | :---- | :-------------------- | - | location | Object.Location | | The vector location. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | location | Object.Location | | The vector location. | + | status | google.rpc.Status | | The RPC error status. | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -1464,49 +1451,47 @@ Please be careful that the size of the request exceeds the limit. - Upsert.MultiObjectRequest - | field | type | label | description | - | :------: | :------------------- | :------- | :---------------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Upsert.ObjectRequest | repeated | Represent the multiple upsert object request content. | - Upsert.ObjectRequest - | field | type | label | description | - | :--------: | :------------ | :---- | :--------------------------------------- | - | object | Object.Blob | | The binary object to be upserted. | - | config | Upsert.Config | | The configuration of the upsert request. | - | vectorizer | Filter.Target | | Filter target. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | object | Object.Blob | | The binary object to be upserted. | + | config | Upsert.Config | | The configuration of the upsert request. | + | vectorizer | Filter.Target | | Filter target. | - Object.Blob - | field | type | label | description | - | :----: | :----- | :---- | :----------------- | - | id | string | | The object ID. | - | object | bytes | | The binary object. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The object ID. | + | object | bytes | | The binary object. | - Upsert.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Upsert timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Upsert timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - ### Output - the scheme of `payload.v1.Object.Locations` @@ -1526,17 +1511,17 @@ Please be careful that the size of the request exceeds the limit. - Object.Locations - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------- | - | locations | Object.Location | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | locations | Object.Location | repeated | | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -1550,3 +1535,4 @@ Please be careful that the size of the request exceeds the limit. | 13 | INTERNAL | Please refer to [Response Status Code](../status.md) for more details. + diff --git a/apis/docs/v1/flush.md b/apis/docs/v1/flush.md index 504c14ef51..421128476c 100644 --- a/apis/docs/v1/flush.md +++ b/apis/docs/v1/flush.md @@ -30,7 +30,6 @@ Flush RPC is the method to remove all vectors. - Flush.Request empty - ### Output - the scheme of `payload.v1.Info.Index.Count` @@ -47,12 +46,12 @@ Flush RPC is the method to remove all vectors. - Info.Index.Count - | field | type | label | description | - | :---------: | :----- | :---- | :--------------------------- | - | stored | uint32 | | The stored index count. | - | uncommitted | uint32 | | The uncommitted index count. | - | indexing | bool | | The indexing index count. | - | saving | bool | | The saving index count. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | stored | uint32 | | The stored index count. | + | uncommitted | uint32 | | The uncommitted index count. | + | indexing | bool | | The indexing index count. | + | saving | bool | | The saving index count. | ### Status Code @@ -66,3 +65,4 @@ Flush RPC is the method to remove all vectors. | 13 | INTERNAL | Please refer to [Response Status Code](../status.md) for more details. + diff --git a/apis/docs/v1/index.md b/apis/docs/v1/index.md index 5379f4efb5..37c3cfc24a 100644 --- a/apis/docs/v1/index.md +++ b/apis/docs/v1/index.md @@ -34,7 +34,6 @@ Represent the RPC to get the index information. - Empty empty - ### Output - the scheme of `payload.v1.Info.Index.Count` @@ -51,12 +50,12 @@ Represent the RPC to get the index information. - Info.Index.Count - | field | type | label | description | - | :---------: | :----- | :---- | :--------------------------- | - | stored | uint32 | | The stored index count. | - | uncommitted | uint32 | | The uncommitted index count. | - | indexing | bool | | The indexing index count. | - | saving | bool | | The saving index count. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | stored | uint32 | | The stored index count. | + | uncommitted | uint32 | | The uncommitted index count. | + | indexing | bool | | The indexing index count. | + | saving | bool | | The saving index count. | ## IndexDetail RPC @@ -76,7 +75,6 @@ Represent the RPC to get the index information for each agents. - Empty empty - ### Output - the scheme of `payload.v1.Info.Index.Detail` @@ -104,27 +102,27 @@ Represent the RPC to get the index information for each agents. - Info.Index.Detail - | field | type | label | description | - | :---------: | :---------------------------- | :------- | :--------------------------------- | - | counts | Info.Index.Detail.CountsEntry | repeated | count infos for each agents | - | replica | uint32 | | index replica of vald cluster | - | live_agents | uint32 | | live agent replica of vald cluster | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | counts | Info.Index.Detail.CountsEntry | repeated | count infos for each agents | + | replica | uint32 | | index replica of vald cluster | + | live_agents | uint32 | | live agent replica of vald cluster | - Info.Index.Detail.CountsEntry - | field | type | label | description | - | :---: | :--------------- | :---- | :---------- | - | key | string | | | - | value | Info.Index.Count | | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | key | string | | | + | value | Info.Index.Count | | | - Info.Index.Count - | field | type | label | description | - | :---------: | :----- | :---- | :--------------------------- | - | stored | uint32 | | The stored index count. | - | uncommitted | uint32 | | The uncommitted index count. | - | indexing | bool | | The indexing index count. | - | saving | bool | | The saving index count. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | stored | uint32 | | The stored index count. | + | uncommitted | uint32 | | The uncommitted index count. | + | indexing | bool | | The indexing index count. | + | saving | bool | | The saving index count. | ## IndexStatistics RPC @@ -144,7 +142,6 @@ Represent the RPC to get the index statistics. - Empty empty - ### Output - the scheme of `payload.v1.Info.Index.Statistics` @@ -190,41 +187,41 @@ Represent the RPC to get the index statistics. - Info.Index.Statistics - | field | type | label | description | - | :----------------------------------: | :----- | :------- | :---------- | - | valid | bool | | | - | median_indegree | int32 | | | - | median_outdegree | int32 | | | - | max_number_of_indegree | uint64 | | | - | max_number_of_outdegree | uint64 | | | - | min_number_of_indegree | uint64 | | | - | min_number_of_outdegree | uint64 | | | - | mode_indegree | uint64 | | | - | mode_outdegree | uint64 | | | - | nodes_skipped_for_10_edges | uint64 | | | - | nodes_skipped_for_indegree_distance | uint64 | | | - | number_of_edges | uint64 | | | - | number_of_indexed_objects | uint64 | | | - | number_of_nodes | uint64 | | | - | number_of_nodes_without_edges | uint64 | | | - | number_of_nodes_without_indegree | uint64 | | | - | number_of_objects | uint64 | | | - | number_of_removed_objects | uint64 | | | - | size_of_object_repository | uint64 | | | - | size_of_refinement_object_repository | uint64 | | | - | variance_of_indegree | double | | | - | variance_of_outdegree | double | | | - | mean_edge_length | double | | | - | mean_edge_length_for_10_edges | double | | | - | mean_indegree_distance_for_10_edges | double | | | - | mean_number_of_edges_per_node | double | | | - | c1_indegree | double | | | - | c5_indegree | double | | | - | c95_outdegree | double | | | - | c99_outdegree | double | | | - | indegree_count | int64 | repeated | | - | outdegree_histogram | uint64 | repeated | | - | indegree_histogram | uint64 | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | valid | bool | | | + | median_indegree | int32 | | | + | median_outdegree | int32 | | | + | max_number_of_indegree | uint64 | | | + | max_number_of_outdegree | uint64 | | | + | min_number_of_indegree | uint64 | | | + | min_number_of_outdegree | uint64 | | | + | mode_indegree | uint64 | | | + | mode_outdegree | uint64 | | | + | nodes_skipped_for_10_edges | uint64 | | | + | nodes_skipped_for_indegree_distance | uint64 | | | + | number_of_edges | uint64 | | | + | number_of_indexed_objects | uint64 | | | + | number_of_nodes | uint64 | | | + | number_of_nodes_without_edges | uint64 | | | + | number_of_nodes_without_indegree | uint64 | | | + | number_of_objects | uint64 | | | + | number_of_removed_objects | uint64 | | | + | size_of_object_repository | uint64 | | | + | size_of_refinement_object_repository | uint64 | | | + | variance_of_indegree | double | | | + | variance_of_outdegree | double | | | + | mean_edge_length | double | | | + | mean_edge_length_for_10_edges | double | | | + | mean_indegree_distance_for_10_edges | double | | | + | mean_number_of_edges_per_node | double | | | + | c1_indegree | double | | | + | c5_indegree | double | | | + | c95_outdegree | double | | | + | c99_outdegree | double | | | + | indegree_count | int64 | repeated | | + | outdegree_histogram | uint64 | repeated | | + | indegree_histogram | uint64 | repeated | | ## IndexStatisticsDetail RPC @@ -244,7 +241,6 @@ Represent the RPC to get the index statistics for each agents. - Empty empty - ### Output - the scheme of `payload.v1.Info.Index.StatisticsDetail` @@ -299,54 +295,54 @@ Represent the RPC to get the index statistics for each agents. - Info.Index.StatisticsDetail - | field | type | label | description | - | :-----: | :--------------------------------------- | :------- | :-------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | details | Info.Index.StatisticsDetail.DetailsEntry | repeated | count infos for each agents | - Info.Index.StatisticsDetail.DetailsEntry - | field | type | label | description | - | :---: | :-------------------- | :---- | :---------- | - | key | string | | | - | value | Info.Index.Statistics | | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | key | string | | | + | value | Info.Index.Statistics | | | - Info.Index.Statistics - | field | type | label | description | - | :----------------------------------: | :----- | :------- | :---------- | - | valid | bool | | | - | median_indegree | int32 | | | - | median_outdegree | int32 | | | - | max_number_of_indegree | uint64 | | | - | max_number_of_outdegree | uint64 | | | - | min_number_of_indegree | uint64 | | | - | min_number_of_outdegree | uint64 | | | - | mode_indegree | uint64 | | | - | mode_outdegree | uint64 | | | - | nodes_skipped_for_10_edges | uint64 | | | - | nodes_skipped_for_indegree_distance | uint64 | | | - | number_of_edges | uint64 | | | - | number_of_indexed_objects | uint64 | | | - | number_of_nodes | uint64 | | | - | number_of_nodes_without_edges | uint64 | | | - | number_of_nodes_without_indegree | uint64 | | | - | number_of_objects | uint64 | | | - | number_of_removed_objects | uint64 | | | - | size_of_object_repository | uint64 | | | - | size_of_refinement_object_repository | uint64 | | | - | variance_of_indegree | double | | | - | variance_of_outdegree | double | | | - | mean_edge_length | double | | | - | mean_edge_length_for_10_edges | double | | | - | mean_indegree_distance_for_10_edges | double | | | - | mean_number_of_edges_per_node | double | | | - | c1_indegree | double | | | - | c5_indegree | double | | | - | c95_outdegree | double | | | - | c99_outdegree | double | | | - | indegree_count | int64 | repeated | | - | outdegree_histogram | uint64 | repeated | | - | indegree_histogram | uint64 | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | valid | bool | | | + | median_indegree | int32 | | | + | median_outdegree | int32 | | | + | max_number_of_indegree | uint64 | | | + | max_number_of_outdegree | uint64 | | | + | min_number_of_indegree | uint64 | | | + | min_number_of_outdegree | uint64 | | | + | mode_indegree | uint64 | | | + | mode_outdegree | uint64 | | | + | nodes_skipped_for_10_edges | uint64 | | | + | nodes_skipped_for_indegree_distance | uint64 | | | + | number_of_edges | uint64 | | | + | number_of_indexed_objects | uint64 | | | + | number_of_nodes | uint64 | | | + | number_of_nodes_without_edges | uint64 | | | + | number_of_nodes_without_indegree | uint64 | | | + | number_of_objects | uint64 | | | + | number_of_removed_objects | uint64 | | | + | size_of_object_repository | uint64 | | | + | size_of_refinement_object_repository | uint64 | | | + | variance_of_indegree | double | | | + | variance_of_outdegree | double | | | + | mean_edge_length | double | | | + | mean_edge_length_for_10_edges | double | | | + | mean_indegree_distance_for_10_edges | double | | | + | mean_number_of_edges_per_node | double | | | + | c1_indegree | double | | | + | c5_indegree | double | | | + | c95_outdegree | double | | | + | c99_outdegree | double | | | + | indegree_count | int64 | repeated | | + | outdegree_histogram | uint64 | repeated | | + | indegree_histogram | uint64 | repeated | | ## IndexProperty RPC @@ -366,7 +362,6 @@ Represent the RPC to get the index property. - Empty empty - ### Output - the scheme of `payload.v1.Info.Index.PropertyDetail` @@ -422,52 +417,53 @@ Represent the RPC to get the index property. - Info.Index.PropertyDetail - | field | type | label | description | - | :-----: | :------------------------------------- | :------- | :---------- | - | details | Info.Index.PropertyDetail.DetailsEntry | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | details | Info.Index.PropertyDetail.DetailsEntry | repeated | | - Info.Index.PropertyDetail.DetailsEntry - | field | type | label | description | - | :---: | :------------------ | :---- | :---------- | - | key | string | | | - | value | Info.Index.Property | | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | key | string | | | + | value | Info.Index.Property | | | - Info.Index.Property - | field | type | label | description | - | :--------------------------------: | :----- | :---- | :---------- | - | dimension | int32 | | | - | thread_pool_size | int32 | | | - | object_type | string | | | - | distance_type | string | | | - | index_type | string | | | - | database_type | string | | | - | object_alignment | string | | | - | path_adjustment_interval | int32 | | | - | graph_shared_memory_size | int32 | | | - | tree_shared_memory_size | int32 | | | - | object_shared_memory_size | int32 | | | - | prefetch_offset | int32 | | | - | prefetch_size | int32 | | | - | accuracy_table | string | | | - | search_type | string | | | - | max_magnitude | float | | | - | n_of_neighbors_for_insertion_order | int32 | | | - | epsilon_for_insertion_order | float | | | - | refinement_object_type | string | | | - | truncation_threshold | int32 | | | - | edge_size_for_creation | int32 | | | - | edge_size_for_search | int32 | | | - | edge_size_limit_for_creation | int32 | | | - | insertion_radius_coefficient | double | | | - | seed_size | int32 | | | - | seed_type | string | | | - | truncation_thread_pool_size | int32 | | | - | batch_size_for_creation | int32 | | | - | graph_type | string | | | - | dynamic_edge_size_base | int32 | | | - | dynamic_edge_size_rate | int32 | | | - | build_time_limit | float | | | - | outgoing_edge | int32 | | | - | incoming_edge | int32 | | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | dimension | int32 | | | + | thread_pool_size | int32 | | | + | object_type | string | | | + | distance_type | string | | | + | index_type | string | | | + | database_type | string | | | + | object_alignment | string | | | + | path_adjustment_interval | int32 | | | + | graph_shared_memory_size | int32 | | | + | tree_shared_memory_size | int32 | | | + | object_shared_memory_size | int32 | | | + | prefetch_offset | int32 | | | + | prefetch_size | int32 | | | + | accuracy_table | string | | | + | search_type | string | | | + | max_magnitude | float | | | + | n_of_neighbors_for_insertion_order | int32 | | | + | epsilon_for_insertion_order | float | | | + | refinement_object_type | string | | | + | truncation_threshold | int32 | | | + | edge_size_for_creation | int32 | | | + | edge_size_for_search | int32 | | | + | edge_size_limit_for_creation | int32 | | | + | insertion_radius_coefficient | double | | | + | seed_size | int32 | | | + | seed_type | string | | | + | truncation_thread_pool_size | int32 | | | + | batch_size_for_creation | int32 | | | + | graph_type | string | | | + | dynamic_edge_size_base | int32 | | | + | dynamic_edge_size_rate | int32 | | | + | build_time_limit | float | | | + | outgoing_edge | int32 | | | + | incoming_edge | int32 | | | + diff --git a/apis/docs/v1/insert.md b/apis/docs/v1/insert.md index 40e91e84cc..c43bf9093b 100644 --- a/apis/docs/v1/insert.md +++ b/apis/docs/v1/insert.md @@ -53,40 +53,39 @@ Inset RPC is the method to add a new single vector. - Insert.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | vector | Object.Vector | | The vector to be inserted. | - | config | Insert.Config | | The configuration of the insert request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector to be inserted. | + | config | Insert.Config | | The configuration of the insert request. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | - Insert.Config - | field | type | label | description | - | :---------------------: | :------------ | :---- | :-------------------------------------------------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | - | filters | Filter.Config | | Filter configurations. | - | timestamp | int64 | | Insert timestamp. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | + | filters | Filter.Config | | Filter configurations. | + | timestamp | int64 | | Insert timestamp. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.Location` @@ -102,25 +101,26 @@ Inset RPC is the method to add a new single vector. - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code | code | description | | :--: | :---------------- | -| 0 | OK | -| 1 | CANCELLED | -| 3 | INVALID_ARGUMENT | -| 4 | DEADLINE_EXCEEDED | -| 5 | NOT_FOUND | -| 13 | INTERNAL | +| 0 | OK | +| 1 | CANCELLED | +| 3 | INVALID_ARGUMENT | +| 4 | DEADLINE_EXCEEDED | +| 5 | NOT_FOUND | +| 13 | INTERNAL | Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -134,7 +134,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## StreamInsert RPC StreamInsert RPC is the method to add new multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
@@ -177,40 +176,39 @@ It's the recommended method to insert a large number of vectors. - Insert.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | vector | Object.Vector | | The vector to be inserted. | - | config | Insert.Config | | The configuration of the insert request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector to be inserted. | + | config | Insert.Config | | The configuration of the insert request. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | - Insert.Config - | field | type | label | description | - | :---------------------: | :------------ | :---- | :-------------------------------------------------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | - | filters | Filter.Config | | Filter configurations. | - | timestamp | int64 | | Insert timestamp. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | + | filters | Filter.Config | | Filter configurations. | + | timestamp | int64 | | Insert timestamp. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.StreamLocation` @@ -231,18 +229,18 @@ It's the recommended method to insert a large number of vectors. - Object.StreamLocation - | field | type | label | description | - | :------: | :---------------- | :---- | :-------------------- | - | location | Object.Location | | The vector location. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | location | Object.Location | | The vector location. | + | status | google.rpc.Status | | The RPC error status. | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -258,6 +256,7 @@ It's the recommended method to insert a large number of vectors. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -271,7 +270,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## MultiInsert RPC MultiInsert RPC is the method to add multiple new vectors in **1** request. @@ -320,46 +318,45 @@ Please be careful that the size of the request exceeds the limit. - Insert.MultiRequest - | field | type | label | description | - | :------: | :------------- | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Insert.Request | repeated | Represent multiple insert request content. | - Insert.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | vector | Object.Vector | | The vector to be inserted. | - | config | Insert.Config | | The configuration of the insert request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector to be inserted. | + | config | Insert.Config | | The configuration of the insert request. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | - Insert.Config - | field | type | label | description | - | :---------------------: | :------------ | :---- | :-------------------------------------------------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | - | filters | Filter.Config | | Filter configurations. | - | timestamp | int64 | | Insert timestamp. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | + | filters | Filter.Config | | Filter configurations. | + | timestamp | int64 | | Insert timestamp. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.Locations` @@ -379,17 +376,17 @@ Please be careful that the size of the request exceeds the limit. - Object.Locations - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------- | - | locations | Object.Location | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | locations | Object.Location | repeated | | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -405,6 +402,7 @@ Please be careful that the size of the request exceeds the limit. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. diff --git a/apis/docs/v1/mirror.md b/apis/docs/v1/mirror.md new file mode 100644 index 0000000000..1790f52691 --- /dev/null +++ b/apis/docs/v1/mirror.md @@ -0,0 +1,87 @@ +# Vald Mirror APIs + +## Overview + +Mirror Service is responsible for providing the `Register` interface for the Vald Mirror Gateway. + +```rpc +service Mirror { + + rpc Register(payload.v1.Mirror.Targets) returns (payload.v1.Mirror.Targets) {} + +} +``` + +## Register RPC + +Register RPC is the method to register other Vald Mirror Gateway targets. + +### Input + +- the scheme of `payload.v1.Mirror.Targets` + + ```rpc + message Mirror.Targets { + repeated Mirror.Target targets = 1; + } + + message Mirror.Target { + string host = 1; + uint32 port = 2; + } + + ``` + + - Mirror.Targets + + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | targets | Mirror.Target | repeated | The multiple target information. | + + - Mirror.Target + + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | +### Output + +- the scheme of `payload.v1.Mirror.Targets` + + ```rpc + message Mirror.Targets { + repeated Mirror.Target targets = 1; + } + + message Mirror.Target { + string host = 1; + uint32 port = 2; + } + + ``` + + - Mirror.Targets + + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | targets | Mirror.Target | repeated | The multiple target information. | + + - Mirror.Target + + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | + +### Status Code + +| code | description | +| :--: | :---------------- | +| 0 | OK | +| 1 | CANCELLED | +| 3 | INVALID_ARGUMENT | +| 4 | DEADLINE_EXCEEDED | +| 13 | INTERNAL | + +Please refer to [Response Status Code](../status.md) for more details. + diff --git a/apis/docs/v1/object.md b/apis/docs/v1/object.md index aee45109cb..827ff9dcc3 100644 --- a/apis/docs/v1/object.md +++ b/apis/docs/v1/object.md @@ -33,10 +33,9 @@ Exists RPC is the method to check that a vector exists in the `vald-agent`. - Object.ID - | field | type | label | description | - | :---: | :----- | :---- | :---------- | - | id | string | | | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | | ### Output - the scheme of `payload.v1.Object.ID` @@ -50,9 +49,9 @@ Exists RPC is the method to check that a vector exists in the `vald-agent`. - Object.ID - | field | type | label | description | - | :---: | :----- | :---- | :---------- | - | id | string | | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | | ### Status Code @@ -67,6 +66,7 @@ Exists RPC is the method to check that a vector exists in the `vald-agent`. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -80,7 +80,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## GetObject RPC GetObject RPC is the method to get the metadata of a vector inserted into the `vald-agent`. @@ -112,30 +111,29 @@ GetObject RPC is the method to get the metadata of a vector inserted into the `v - Object.VectorRequest - | field | type | label | description | - | :-----: | :------------ | :---- | :--------------------------- | - | id | Object.ID | | The vector ID to be fetched. | - | filters | Filter.Config | | Filter configurations. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | Object.ID | | The vector ID to be fetched. | + | filters | Filter.Config | | Filter configurations. | - Object.ID - | field | type | label | description | - | :---: | :----- | :---- | :---------- | - | id | string | | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.Vector` @@ -151,11 +149,11 @@ GetObject RPC is the method to get the metadata of a vector inserted into the `v - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | ### Status Code @@ -170,6 +168,7 @@ GetObject RPC is the method to get the metadata of a vector inserted into the `v Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -183,7 +182,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## StreamGetObject RPC StreamGetObject RPC is the method to get the metadata of multiple existing vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
@@ -217,30 +215,29 @@ Each Upsert request and response are independent. - Object.VectorRequest - | field | type | label | description | - | :-----: | :------------ | :---- | :--------------------------- | - | id | Object.ID | | The vector ID to be fetched. | - | filters | Filter.Config | | Filter configurations. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | Object.ID | | The vector ID to be fetched. | + | filters | Filter.Config | | Filter configurations. | - Object.ID - | field | type | label | description | - | :---: | :----- | :---- | :---------- | - | id | string | | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.StreamVector` @@ -261,18 +258,18 @@ Each Upsert request and response are independent. - Object.StreamVector - | field | type | label | description | - | :----: | :---------------- | :---- | :-------------------- | - | vector | Object.Vector | | The vector. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector. | + | status | google.rpc.Status | | The RPC error status. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | ### Status Code @@ -287,6 +284,7 @@ Each Upsert request and response are independent. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -300,7 +298,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## StreamListObject RPC A method to get all the vectors with server streaming @@ -319,7 +316,6 @@ A method to get all the vectors with server streaming - Object.List.Request empty - ### Output - the scheme of `payload.v1.Object.List.Response` @@ -340,32 +336,31 @@ A method to get all the vectors with server streaming - Object.List.Response - | field | type | label | description | - | :----: | :---------------- | :---- | :-------------------- | - | vector | Object.Vector | | The vector | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector | + | status | google.rpc.Status | | The RPC error status. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | ### Status Code -| code | description | -| :--: | :---------- | - +| code | description | +| :--: | :---------------- | TODO Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting TODO - ## GetTimestamp RPC Represent the RPC to get the vector metadata. This RPC is mainly used for index correction process @@ -387,16 +382,15 @@ Represent the RPC to get the vector metadata. This RPC is mainly used for index - Object.TimestampRequest - | field | type | label | description | - | :---: | :-------- | :---- | :--------------------------- | - | id | Object.ID | | The vector ID to be fetched. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | Object.ID | | The vector ID to be fetched. | - Object.ID - | field | type | label | description | - | :---: | :----- | :---- | :---------- | - | id | string | | | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | | ### Output - the scheme of `payload.v1.Object.Timestamp` @@ -411,20 +405,20 @@ Represent the RPC to get the vector metadata. This RPC is mainly used for index - Object.Timestamp - | field | type | label | description | - | :-------: | :----- | :---- | :---------------------------------------------- | - | id | string | | The vector ID. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | timestamp | int64 | | timestamp represents when this vector inserted. | ### Status Code -| code | description | -| :--: | :---------- | - +| code | description | +| :--: | :---------------- | TODO Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting TODO diff --git a/apis/docs/v1/payload.md.tmpl b/apis/docs/v1/payload.md.tmpl index 0acb24308d..769f09b1e6 100644 --- a/apis/docs/v1/payload.md.tmpl +++ b/apis/docs/v1/payload.md.tmpl @@ -940,8 +940,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | pool_size | uint32 | | The pool size of the create index operation. | - - {{- end -}} {{- define "_scheme:payload.v1.Discoverer" }} @@ -972,8 +970,6 @@ | name | string | | The agent name to be discovered. | | namespace | string | | The namespace to be discovered. | | node | string | | The node to be discovered. | - - {{- end -}} {{- define "_scheme:payload.v1.Empty" }} @@ -1012,8 +1008,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - {{- end -}} {{- define "_scheme:payload.v1.Filter.Target" }} @@ -1030,8 +1024,6 @@ | :---: | :--- | :---- | :---------- | | host | string | | The target hostname. | | port | uint32 | | The target port. | - - {{- end -}} {{- define "_scheme:payload.v1.Flush" }} @@ -1082,8 +1074,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | annotations | Info.Annotations.AnnotationsEntry | repeated | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Annotations.AnnotationsEntry" }} @@ -1100,8 +1090,6 @@ | :---: | :--- | :---- | :---------- | | key | string | | | | value | string | | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.CPU" }} @@ -1120,8 +1108,6 @@ | limit | double | | The CPU resource limit. | | request | double | | The CPU resource requested. | | usage | double | | The CPU usage. | - - {{- end -}} {{- define "_scheme:payload.v1.Info.IPs" }} @@ -1136,8 +1122,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | ip | string | repeated | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index" }} @@ -1170,8 +1154,6 @@ | uncommitted | uint32 | | The uncommitted index count. | | indexing | bool | | The indexing index count. | | saving | bool | | The saving index count. | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index.Detail" }} @@ -1190,8 +1172,6 @@ | counts | Info.Index.Detail.CountsEntry | repeated | count infos for each agents | | replica | uint32 | | index replica of vald cluster | | live_agents | uint32 | | live agent replica of vald cluster | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index.Detail.CountsEntry" }} @@ -1208,8 +1188,6 @@ | :---: | :--- | :---- | :---------- | | key | string | | | | value | Info.Index.Count | | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index.Property" }} @@ -1290,8 +1268,6 @@ | build_time_limit | float | | | | outgoing_edge | int32 | | | | incoming_edge | int32 | | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index.PropertyDetail" }} @@ -1306,8 +1282,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | details | Info.Index.PropertyDetail.DetailsEntry | repeated | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index.PropertyDetail.DetailsEntry" }} @@ -1324,8 +1298,6 @@ | :---: | :--- | :---- | :---------- | | key | string | | | | value | Info.Index.Property | | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index.Statistics" }} @@ -1404,8 +1376,6 @@ | indegree_count | int64 | repeated | | | outdegree_histogram | uint64 | repeated | | | indegree_histogram | uint64 | repeated | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index.StatisticsDetail" }} @@ -1420,8 +1390,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | details | Info.Index.StatisticsDetail.DetailsEntry | repeated | count infos for each agents | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index.StatisticsDetail.DetailsEntry" }} @@ -1438,8 +1406,6 @@ | :---: | :--- | :---- | :---------- | | key | string | | | | value | Info.Index.Statistics | | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index.UUID" }} @@ -1466,8 +1432,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | uuid | string | | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Index.UUID.Uncommitted" }} @@ -1482,8 +1446,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | uuid | string | | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Labels" }} @@ -1498,8 +1460,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | labels | Info.Labels.LabelsEntry | repeated | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Labels.LabelsEntry" }} @@ -1516,8 +1476,6 @@ | :---: | :--- | :---- | :---------- | | key | string | | | | value | string | | | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Memory" }} @@ -1536,8 +1494,6 @@ | limit | double | | The memory limit. | | request | double | | The memory requested. | | usage | double | | The memory usage. | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Node" }} @@ -1562,8 +1518,6 @@ | cpu | Info.CPU | | The CPU information of the node. | | memory | Info.Memory | | The memory information of the node. | | Pods | Info.Pods | | The pod information of the node. | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Nodes" }} @@ -1578,8 +1532,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | nodes | Info.Node | repeated | The multiple node information. | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Pod" }} @@ -1606,8 +1558,6 @@ | cpu | Info.CPU | | The CPU information of the pod. | | memory | Info.Memory | | The memory information of the pod. | | node | Info.Node | | The node information of the pod. | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Pods" }} @@ -1622,8 +1572,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | pods | Info.Pod | repeated | The multiple pod information. | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Service" }} @@ -1648,8 +1596,6 @@ | ports | Info.ServicePort | repeated | The port of the svc. | | labels | Info.Labels | | The labels of the service. | | annotations | Info.Annotations | | The annotations of the service. | - - {{- end -}} {{- define "_scheme:payload.v1.Info.ServicePort" }} @@ -1666,8 +1612,6 @@ | :---: | :--- | :---- | :---------- | | name | string | | The name of the port. | | port | int32 | | The port number | - - {{- end -}} {{- define "_scheme:payload.v1.Info.Services" }} @@ -1682,8 +1626,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | services | Info.Service | repeated | The multiple service information. | - - {{- end -}} {{- define "_scheme:payload.v1.Insert" }} @@ -1714,8 +1656,6 @@ | skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. | | filters | Filter.Config | | Filter configurations. | | timestamp | int64 | | Insert timestamp. | - - {{- end -}} {{- define "_scheme:payload.v1.Insert.MultiObjectRequest" }} @@ -1730,8 +1670,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | requests | Insert.ObjectRequest | repeated | Represent multiple insert by object content. | - - {{- end -}} {{- define "_scheme:payload.v1.Insert.MultiRequest" }} @@ -1746,8 +1684,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | requests | Insert.Request | repeated | Represent multiple insert request content. | - - {{- end -}} {{- define "_scheme:payload.v1.Insert.ObjectRequest" }} @@ -1766,8 +1702,6 @@ | object | Object.Blob | | The binary object to be inserted. | | config | Insert.Config | | The configuration of the insert request. | | vectorizer | Filter.Target | | Filter configurations. | - - {{- end -}} {{- define "_scheme:payload.v1.Insert.Request" }} @@ -1784,8 +1718,6 @@ | :---: | :--- | :---- | :---------- | | vector | Object.Vector | | The vector to be inserted. | | config | Insert.Config | | The configuration of the insert request. | - - {{- end -}} {{- define "_scheme:payload.v1.Meta" }} @@ -1812,8 +1744,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | key | string | | | - - {{- end -}} {{- define "_scheme:payload.v1.Meta.KeyValue" }} @@ -1830,8 +1760,6 @@ | :---: | :--- | :---- | :---------- | | key | Meta.Key | | | | value | Meta.Value | | | - - {{- end -}} {{- define "_scheme:payload.v1.Meta.Value" }} @@ -1846,8 +1774,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | value | google.protobuf.Any | | | - - {{- end -}} {{- define "_scheme:payload.v1.Mirror" }} @@ -1876,8 +1802,6 @@ | :---: | :--- | :---- | :---------- | | host | string | | The target hostname. | | port | uint32 | | The target port. | - - {{- end -}} {{- define "_scheme:payload.v1.Mirror.Targets" }} @@ -1892,8 +1816,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | targets | Mirror.Target | repeated | The multiple target information. | - - {{- end -}} {{- define "_scheme:payload.v1.Object" }} @@ -1922,8 +1844,6 @@ | :---: | :--- | :---- | :---------- | | id | string | | The object ID. | | object | bytes | | The binary object. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.Distance" }} @@ -1940,8 +1860,6 @@ | :---: | :--- | :---- | :---------- | | id | string | | The vector ID. | | distance | float | | The distance. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.ID" }} @@ -1956,8 +1874,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | id | string | | | - - {{- end -}} {{- define "_scheme:payload.v1.Object.IDs" }} @@ -1972,8 +1888,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | ids | string | repeated | | - - {{- end -}} {{- define "_scheme:payload.v1.Object.List" }} @@ -2014,8 +1928,6 @@ | :---: | :--- | :---- | :---------- | | vector | Object.Vector | | The vector | | status | google.rpc.Status | | The RPC error status. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.Location" }} @@ -2034,8 +1946,6 @@ | name | string | | The name of the location. | | uuid | string | | The UUID of the vector. | | ips | string | repeated | The IP list. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.Locations" }} @@ -2050,8 +1960,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | locations | Object.Location | repeated | | - - {{- end -}} {{- define "_scheme:payload.v1.Object.ReshapeVector" }} @@ -2068,8 +1976,6 @@ | :---: | :--- | :---- | :---------- | | object | bytes | | The binary object. | | shape | int32 | repeated | The new shape. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.StreamBlob" }} @@ -2086,8 +1992,6 @@ | :---: | :--- | :---- | :---------- | | blob | Object.Blob | | The binary object. | | status | google.rpc.Status | | The RPC error status. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.StreamDistance" }} @@ -2104,8 +2008,6 @@ | :---: | :--- | :---- | :---------- | | distance | Object.Distance | | The distance. | | status | google.rpc.Status | | The RPC error status. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.StreamLocation" }} @@ -2122,8 +2024,6 @@ | :---: | :--- | :---- | :---------- | | location | Object.Location | | The vector location. | | status | google.rpc.Status | | The RPC error status. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.StreamVector" }} @@ -2140,8 +2040,6 @@ | :---: | :--- | :---- | :---------- | | vector | Object.Vector | | The vector. | | status | google.rpc.Status | | The RPC error status. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.Timestamp" }} @@ -2158,8 +2056,6 @@ | :---: | :--- | :---- | :---------- | | id | string | | The vector ID. | | timestamp | int64 | | timestamp represents when this vector inserted. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.TimestampRequest" }} @@ -2174,8 +2070,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | id | Object.ID | | The vector ID to be fetched. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.Vector" }} @@ -2194,8 +2088,6 @@ | id | string | | The vector ID. | | vector | float | repeated | The vector. | | timestamp | int64 | | timestamp represents when this vector inserted. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.VectorRequest" }} @@ -2212,8 +2104,6 @@ | :---: | :--- | :---- | :---------- | | id | Object.ID | | The vector ID to be fetched. | | filters | Filter.Config | | Filter configurations. | - - {{- end -}} {{- define "_scheme:payload.v1.Object.Vectors" }} @@ -2228,8 +2118,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | vectors | Object.Vector | repeated | | - - {{- end -}} {{- define "_scheme:payload.v1.Remove" }} @@ -2258,8 +2146,6 @@ | :---: | :--- | :---- | :---------- | | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | | timestamp | int64 | | Remove timestamp. | - - {{- end -}} {{- define "_scheme:payload.v1.Remove.MultiRequest" }} @@ -2274,8 +2160,6 @@ | field | type | label | description | | :---: | :--- | :---- | :---------- | | requests | Remove.Request | repeated | Represent the multiple remove request content. | - - {{- end -}} {{- define "_scheme:payload.v1.Remove.Request" }} @@ -2292,8 +2176,6 @@ | :---: | :--- | :---- | :---------- | | id | Object.ID | | The object ID to be removed. | | config | Remove.Config | | The configuration of the remove request. | - - {{- end -}} {{- define "_scheme:payload.v1.Remove.Timestamp" }} @@ -2310,8 +2192,6 @@ | :---: | :--- | :---- | :---------- | | timestamp | int64 | | The timestamp. | | operator | Remove.Timestamp.Operator | | The conditional operator. | - - {{- end -}} {{- define "_scheme:payload.v1.Remove.TimestampRequest" }} @@ -2327,8 +2207,6 @@ | :---: | :--- | :---- | :---------- | | timestamps | Remove.Timestamp | repeated | The timestamp comparison list. If more than one is specified, the `AND` search is applied. | - - {{- end -}} {{- define "_scheme:payload.v1.Search" }} @@ -2375,8 +2253,6 @@ search is applied. | | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | | nprobe | uint32 | | Search nprobe. | - - {{- end -}} {{- define "_scheme:payload.v1.Search.IDRequest" }} @@ -2393,8 +2269,6 @@ search is applied. | | :---: | :--- | :---- | :---------- | | id | string | | The vector ID to be searched. | | config | Search.Config | | The configuration of the search request. | - - {{- end -}} {{- define "_scheme:payload.v1.Search.MultiIDRequest" }} @@ -2409,8 +2283,6 @@ search is applied. | | field | type | label | description | | :---: | :--- | :---- | :---------- | | requests | Search.IDRequest | repeated | Represent the multiple search by ID request content. | - - {{- end -}} {{- define "_scheme:payload.v1.Search.MultiObjectRequest" }} @@ -2425,8 +2297,6 @@ search is applied. | | field | type | label | description | | :---: | :--- | :---- | :---------- | | requests | Search.ObjectRequest | repeated | Represent the multiple search by binary object request content. | - - {{- end -}} {{- define "_scheme:payload.v1.Search.MultiRequest" }} @@ -2441,8 +2311,6 @@ search is applied. | | field | type | label | description | | :---: | :--- | :---- | :---------- | | requests | Search.Request | repeated | Represent the multiple search request content. | - - {{- end -}} {{- define "_scheme:payload.v1.Search.ObjectRequest" }} @@ -2461,8 +2329,6 @@ search is applied. | | object | bytes | | The binary object to be searched. | | config | Search.Config | | The configuration of the search request. | | vectorizer | Filter.Target | | Filter configuration. | - - {{- end -}} {{- define "_scheme:payload.v1.Search.Request" }} @@ -2479,8 +2345,6 @@ search is applied. | | :---: | :--- | :---- | :---------- | | vector | float | repeated | The vector to be searched. | | config | Search.Config | | The configuration of the search request. | - - {{- end -}} {{- define "_scheme:payload.v1.Search.Response" }} @@ -2497,8 +2361,6 @@ search is applied. | | :---: | :--- | :---- | :---------- | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated | Search results. | - - {{- end -}} {{- define "_scheme:payload.v1.Search.Responses" }} @@ -2513,8 +2375,6 @@ search is applied. | | field | type | label | description | | :---: | :--- | :---- | :---------- | | responses | Search.Response | repeated | Represent the multiple search response content. | - - {{- end -}} {{- define "_scheme:payload.v1.Search.StreamResponse" }} @@ -2531,8 +2391,6 @@ search is applied. | | :---: | :--- | :---- | :---------- | | response | Search.Response | | Represent the search response. | | status | google.rpc.Status | | The RPC error status. | - - {{- end -}} {{- define "_scheme:payload.v1.Update" }} @@ -2566,8 +2424,6 @@ search is applied. | | timestamp | int64 | | Update timestamp. | | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - - {{- end -}} {{- define "_scheme:payload.v1.Update.MultiObjectRequest" }} @@ -2582,8 +2438,6 @@ during update operation. | | field | type | label | description | | :---: | :--- | :---- | :---------- | | requests | Update.ObjectRequest | repeated | Represent the multiple update object request content. | - - {{- end -}} {{- define "_scheme:payload.v1.Update.MultiRequest" }} @@ -2598,8 +2452,6 @@ during update operation. | | field | type | label | description | | :---: | :--- | :---- | :---------- | | requests | Update.Request | repeated | Represent the multiple update request content. | - - {{- end -}} {{- define "_scheme:payload.v1.Update.ObjectRequest" }} @@ -2618,8 +2470,6 @@ during update operation. | | object | Object.Blob | | The binary object to be updated. | | config | Update.Config | | The configuration of the update request. | | vectorizer | Filter.Target | | Filter target. | - - {{- end -}} {{- define "_scheme:payload.v1.Update.Request" }} @@ -2636,8 +2486,6 @@ during update operation. | | :---: | :--- | :---- | :---------- | | vector | Object.Vector | | The vector to be updated. | | config | Update.Config | | The configuration of the update request. | - - {{- end -}} {{- define "_scheme:payload.v1.Update.TimestampRequest" }} @@ -2656,8 +2504,6 @@ during update operation. | | id | string | | The vector ID. | | timestamp | int64 | | timestamp represents when this vector inserted. | | force | bool | | force represents forcefully update the timestamp. | - - {{- end -}} {{- define "_scheme:payload.v1.Upsert" }} @@ -2691,8 +2537,6 @@ during update operation. | | timestamp | int64 | | Upsert timestamp. | | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - - {{- end -}} {{- define "_scheme:payload.v1.Upsert.MultiObjectRequest" }} @@ -2707,8 +2551,6 @@ during update operation. | | field | type | label | description | | :---: | :--- | :---- | :---------- | | requests | Upsert.ObjectRequest | repeated | Represent the multiple upsert object request content. | - - {{- end -}} {{- define "_scheme:payload.v1.Upsert.MultiRequest" }} @@ -2723,8 +2565,6 @@ during update operation. | | field | type | label | description | | :---: | :--- | :---- | :---------- | | requests | Upsert.Request | repeated | Represent the multiple upsert request content. | - - {{- end -}} {{- define "_scheme:payload.v1.Upsert.ObjectRequest" }} @@ -2743,8 +2583,6 @@ during update operation. | | object | Object.Blob | | The binary object to be upserted. | | config | Upsert.Config | | The configuration of the upsert request. | | vectorizer | Filter.Target | | Filter target. | - - {{- end -}} {{- define "_scheme:payload.v1.Upsert.Request" }} @@ -2761,12 +2599,10 @@ during update operation. | | :---: | :--- | :---- | :---------- | | vector | Object.Vector | | The vector to be upserted. | | config | Upsert.Config | | The configuration of the upsert request. | - - {{- end -}} {{ define "_scheme:payload.v1.Remove.Timestamp.Operator" }} - enum Remove.Timestamp.Operator { + enum Remove.Timestamp.Operator { Eq = 0; Ne = 1; Ge = 2; @@ -2776,9 +2612,9 @@ during update operation. | } {{- end -}} -{{ define "_field:payload.v1.Remove.Timestamp.Operator" }}{{- end -}} +{{- define "_field:payload.v1.Remove.Timestamp.Operator" -}}{{- end -}} {{ define "_scheme:payload.v1.Search.AggregationAlgorithm" }} - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -2787,4 +2623,4 @@ during update operation. | } {{- end -}} -{{ define "_field:payload.v1.Search.AggregationAlgorithm" }}{{- end -}} +{{- define "_field:payload.v1.Search.AggregationAlgorithm" -}}{{- end -}} diff --git a/apis/docs/v1/payload.tmpl b/apis/docs/v1/payload.tmpl index 97d8664e1e..1735a7cc69 100644 --- a/apis/docs/v1/payload.tmpl +++ b/apis/docs/v1/payload.tmpl @@ -82,20 +82,19 @@ {{- range .Fields }} | {{ .Name }} | {{ .LongType }} | {{.Label }} | {{ .Description }} | {{- end }} - - {{ else }} + {{- else }} empty {{- end -}} {{- println "\n{{- end -}}\n" -}} {{- end -}} {{- range .Enums -}} {{- printf "{{ define \"_scheme:%s\" }}" .FullName }} - enum {{ .LongName }} { + enum {{ .LongName }} { {{- range .Values }} {{ .Name }} = {{ .Number }}; {{- end }} } {{- println "\n{{- end -}}\n" -}} - {{- printf "{{ define \"_field:%s\" }}{{- end -}}\n" .FullName -}} + {{- printf "{{- define \"_field:%s\" -}}{{- end -}}\n" .FullName -}} {{- end -}} {{- end -}} diff --git a/apis/docs/v1/remove.md b/apis/docs/v1/remove.md index 844643e208..f50ed1be3f 100644 --- a/apis/docs/v1/remove.md +++ b/apis/docs/v1/remove.md @@ -42,24 +42,23 @@ Remove RPC is the method to remove a single vector. - Remove.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | id | Object.ID | | The object ID to be removed. | - | config | Remove.Config | | The configuration of the remove request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | Object.ID | | The object ID to be removed. | + | config | Remove.Config | | The configuration of the remove request. | - Object.ID - | field | type | label | description | - | :---: | :----- | :---- | :---------- | - | id | string | | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | | - Remove.Config - | field | type | label | description | - | :---------------------: | :---- | :---- | :-------------------------------------------------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | - | timestamp | int64 | | Remove timestamp. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | + | timestamp | int64 | | Remove timestamp. | ### Output - the scheme of `payload.v1.Object.Location` @@ -75,11 +74,11 @@ Remove RPC is the method to remove a single vector. - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -95,6 +94,7 @@ Remove RPC is the method to remove a single vector. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -108,7 +108,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## RemoveByTimestamp RPC RemoveByTimestamp RPC is the method to remove vectors based on timestamp. @@ -133,7 +132,7 @@ This design allows for versatile deletion operations, facilitating tasks such as Remove.Timestamp.Operator operator = 2; } - enum Remove.Timestamp.Operator { + enum Remove.Timestamp.Operator { Eq = 0; Ne = 1; Ge = 2; @@ -146,18 +145,17 @@ This design allows for versatile deletion operations, facilitating tasks such as - Remove.TimestampRequest - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | timestamps | Remove.Timestamp | repeated | The timestamp comparison list. If more than one is specified, the `AND` - - search is applied. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | timestamps | Remove.Timestamp | repeated | The timestamp comparison list. If more than one is specified, the `AND` +search is applied. | - Remove.Timestamp - | field | type | label | description | - | :-------: | :------------------------ | :---- | :------------------------ | - | timestamp | int64 | | The timestamp. | - | operator | Remove.Timestamp.Operator | | The conditional operator. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | timestamp | int64 | | The timestamp. | + | operator | Remove.Timestamp.Operator | | The conditional operator. | ### Output @@ -178,17 +176,17 @@ This design allows for versatile deletion operations, facilitating tasks such as - Object.Locations - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------- | - | locations | Object.Location | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | locations | Object.Location | repeated | | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -202,6 +200,7 @@ This design allows for versatile deletion operations, facilitating tasks such as Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -213,8 +212,7 @@ Here are some common reasons and how to resolve each error. | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | No vectors in the system match the specified timestamp conditions. | Check whether vectors matching the specified timestamp conditions exist in the system, and fix conditions if needed. | -| INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - +| INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. ## StreamRemove RPC A method to remove multiple indexed vectors by bidirectional streaming. @@ -247,24 +245,23 @@ It's the recommended method to remove a large number of vectors. - Remove.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | id | Object.ID | | The object ID to be removed. | - | config | Remove.Config | | The configuration of the remove request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | Object.ID | | The object ID to be removed. | + | config | Remove.Config | | The configuration of the remove request. | - Object.ID - | field | type | label | description | - | :---: | :----- | :---- | :---------- | - | id | string | | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | | - Remove.Config - | field | type | label | description | - | :---------------------: | :---- | :---- | :-------------------------------------------------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | - | timestamp | int64 | | Remove timestamp. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | + | timestamp | int64 | | Remove timestamp. | ### Output - the scheme of `payload.v1.Object.StreamLocation` @@ -285,18 +282,18 @@ It's the recommended method to remove a large number of vectors. - Object.StreamLocation - | field | type | label | description | - | :------: | :---------------- | :---- | :-------------------- | - | location | Object.Location | | The vector location. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | location | Object.Location | | The vector location. | + | status | google.rpc.Status | | The RPC error status. | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -312,6 +309,7 @@ It's the recommended method to remove a large number of vectors. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -325,7 +323,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## MultiRemove RPC MultiRemove is the method to remove multiple vectors in **1** request. @@ -362,30 +359,29 @@ Please be careful that the size of the request exceeds the limit. - Remove.MultiRequest - | field | type | label | description | - | :------: | :------------- | :------- | :--------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Remove.Request | repeated | Represent the multiple remove request content. | - Remove.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | id | Object.ID | | The object ID to be removed. | - | config | Remove.Config | | The configuration of the remove request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | Object.ID | | The object ID to be removed. | + | config | Remove.Config | | The configuration of the remove request. | - Object.ID - | field | type | label | description | - | :---: | :----- | :---- | :---------- | - | id | string | | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | | - Remove.Config - | field | type | label | description | - | :---------------------: | :---- | :---- | :-------------------------------------------------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | - | timestamp | int64 | | Remove timestamp. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | + | timestamp | int64 | | Remove timestamp. | ### Output - the scheme of `payload.v1.Object.Locations` @@ -405,17 +401,17 @@ Please be careful that the size of the request exceeds the limit. - Object.Locations - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------- | - | locations | Object.Location | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | locations | Object.Location | repeated | | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -431,6 +427,7 @@ Please be careful that the size of the request exceeds the limit. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. diff --git a/apis/docs/v1/search.md b/apis/docs/v1/search.md index d53ed747c9..eb366ab491 100644 --- a/apis/docs/v1/search.md +++ b/apis/docs/v1/search.md @@ -55,7 +55,7 @@ Search RPC is the method to search vector(s) similar to the request vector. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -72,40 +72,40 @@ Search RPC is the method to search vector(s) similar to the request vector. - Search.Request - | field | type | label | description | - | :----: | :------------ | :------- | :--------------------------------------- | - | vector | float | repeated | The vector to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | float | repeated | The vector to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.Response` @@ -125,17 +125,17 @@ Search RPC is the method to search vector(s) similar to the request vector. - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -151,6 +151,7 @@ Search RPC is the method to search vector(s) similar to the request vector. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -164,7 +165,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## SearchByID RPC SearchByID RPC is the method to search similar vectors using a user-defined vector ID.
@@ -198,7 +198,7 @@ The vector with the same requested ID should be indexed into the `vald-agent` be repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -215,40 +215,40 @@ The vector with the same requested ID should be indexed into the `vald-agent` be - Search.IDRequest - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | id | string | | The vector ID to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.Response` @@ -268,17 +268,17 @@ The vector with the same requested ID should be indexed into the `vald-agent` be - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -294,6 +294,7 @@ The vector with the same requested ID should be indexed into the `vald-agent` be Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -307,7 +308,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## StreamSearch RPC StreamSearch RPC is the method to search vectors with multi queries(vectors) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
@@ -342,7 +342,7 @@ Each Search request and response are independent. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -359,40 +359,40 @@ Each Search request and response are independent. - Search.Request - | field | type | label | description | - | :----: | :------------ | :------- | :--------------------------------------- | - | vector | float | repeated | The vector to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | float | repeated | The vector to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.StreamResponse` @@ -417,24 +417,24 @@ Each Search request and response are independent. - Search.StreamResponse - | field | type | label | description | - | :------: | :---------------- | :---- | :----------------------------- | - | response | Search.Response | | Represent the search response. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | response | Search.Response | | Represent the search response. | + | status | google.rpc.Status | | The RPC error status. | - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -450,6 +450,7 @@ Each Search request and response are independent. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -463,7 +464,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## StreamSearchByID RPC StreamSearchByID RPC is the method to search vectors with multi queries(IDs) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
@@ -498,7 +498,7 @@ Each SearchByID request and response are independent. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -515,40 +515,40 @@ Each SearchByID request and response are independent. - Search.IDRequest - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | id | string | | The vector ID to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.StreamResponse` @@ -573,24 +573,24 @@ Each SearchByID request and response are independent. - Search.StreamResponse - | field | type | label | description | - | :------: | :---------------- | :---- | :----------------------------- | - | response | Search.Response | | Represent the search response. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | response | Search.Response | | Represent the search response. | + | status | google.rpc.Status | | The RPC error status. | - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -606,6 +606,7 @@ Each SearchByID request and response are independent. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -619,7 +620,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## MultiSearch RPC MultiSearch RPC is the method to search vectors with multiple vectors in **1** request. @@ -661,7 +661,7 @@ Please be careful that the size of the request exceeds the limit. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -678,46 +678,46 @@ Please be careful that the size of the request exceeds the limit. - Search.MultiRequest - | field | type | label | description | - | :------: | :------------- | :------- | :--------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Search.Request | repeated | Represent the multiple search request content. | - Search.Request - | field | type | label | description | - | :----: | :------------ | :------- | :--------------------------------------- | - | vector | float | repeated | The vector to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | float | repeated | The vector to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.Responses` @@ -741,23 +741,23 @@ Please be careful that the size of the request exceeds the limit. - Search.Responses - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | responses | Search.Response | repeated | Represent the multiple search response content. | - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -773,6 +773,7 @@ Please be careful that the size of the request exceeds the limit. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -786,7 +787,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## MultiSearchByID RPC MultiSearchByID RPC is the method to search vectors with multiple IDs in **1** request. @@ -828,7 +828,7 @@ Please be careful that the size of the request exceeds the limit. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -845,46 +845,46 @@ Please be careful that the size of the request exceeds the limit. - Search.MultiIDRequest - | field | type | label | description | - | :------: | :--------------- | :------- | :--------------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Search.IDRequest | repeated | Represent the multiple search by ID request content. | - Search.IDRequest - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | id | string | | The vector ID to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.Responses` @@ -908,23 +908,23 @@ Please be careful that the size of the request exceeds the limit. - Search.Responses - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | responses | Search.Response | repeated | Represent the multiple search response content. | - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -940,6 +940,7 @@ Please be careful that the size of the request exceeds the limit. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -953,7 +954,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## LinearSearch RPC LinearSearch RPC is the method to linear search vector(s) similar to the request vector. @@ -986,7 +986,7 @@ LinearSearch RPC is the method to linear search vector(s) similar to the request repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -1003,40 +1003,40 @@ LinearSearch RPC is the method to linear search vector(s) similar to the request - Search.Request - | field | type | label | description | - | :----: | :------------ | :------- | :--------------------------------------- | - | vector | float | repeated | The vector to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | float | repeated | The vector to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.Response` @@ -1056,17 +1056,17 @@ LinearSearch RPC is the method to linear search vector(s) similar to the request - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -1082,6 +1082,7 @@ LinearSearch RPC is the method to linear search vector(s) similar to the request Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -1095,7 +1096,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## LinearSearchByID RPC LinearSearchByID RPC is the method to linear search similar vectors using a user-defined vector ID.
@@ -1130,7 +1130,7 @@ You will get a `NOT_FOUND` error if the vector isn't stored. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -1147,40 +1147,40 @@ You will get a `NOT_FOUND` error if the vector isn't stored. - Search.IDRequest - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | id | string | | The vector ID to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.Response` @@ -1200,17 +1200,17 @@ You will get a `NOT_FOUND` error if the vector isn't stored. - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -1226,6 +1226,7 @@ You will get a `NOT_FOUND` error if the vector isn't stored. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -1239,7 +1240,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## StreamLinearSearch RPC StreamLinearSearch RPC is the method to linear search vectors with multi queries(vectors) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
@@ -1274,7 +1274,7 @@ Each LinearSearch request and response are independent. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -1291,40 +1291,40 @@ Each LinearSearch request and response are independent. - Search.Request - | field | type | label | description | - | :----: | :------------ | :------- | :--------------------------------------- | - | vector | float | repeated | The vector to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | float | repeated | The vector to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.StreamResponse` @@ -1349,24 +1349,24 @@ Each LinearSearch request and response are independent. - Search.StreamResponse - | field | type | label | description | - | :------: | :---------------- | :---- | :----------------------------- | - | response | Search.Response | | Represent the search response. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | response | Search.Response | | Represent the search response. | + | status | google.rpc.Status | | The RPC error status. | - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -1382,6 +1382,7 @@ Each LinearSearch request and response are independent. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -1395,7 +1396,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## StreamLinearSearchByID RPC StreamLinearSearchByID RPC is the method to linear search vectors with multi queries(IDs) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
@@ -1430,7 +1430,7 @@ Each LinearSearchByID request and response are independent. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -1447,40 +1447,40 @@ Each LinearSearchByID request and response are independent. - Search.IDRequest - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | id | string | | The vector ID to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.StreamResponse` @@ -1505,24 +1505,24 @@ Each LinearSearchByID request and response are independent. - Search.StreamResponse - | field | type | label | description | - | :------: | :---------------- | :---- | :----------------------------- | - | response | Search.Response | | Represent the search response. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | response | Search.Response | | Represent the search response. | + | status | google.rpc.Status | | The RPC error status. | - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -1538,6 +1538,7 @@ Each LinearSearchByID request and response are independent. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -1551,7 +1552,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## MultiLinearSearch RPC MultiLinearSearch RPC is the method to linear search vectors with multiple vectors in **1** request. @@ -1593,7 +1593,7 @@ Please be careful that the size of the request exceeds the limit. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -1610,46 +1610,46 @@ Please be careful that the size of the request exceeds the limit. - Search.MultiRequest - | field | type | label | description | - | :------: | :------------- | :------- | :--------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Search.Request | repeated | Represent the multiple search request content. | - Search.Request - | field | type | label | description | - | :----: | :------------ | :------- | :--------------------------------------- | - | vector | float | repeated | The vector to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | float | repeated | The vector to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.Responses` @@ -1673,23 +1673,23 @@ Please be careful that the size of the request exceeds the limit. - Search.Responses - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | responses | Search.Response | repeated | Represent the multiple search response content. | - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -1705,6 +1705,7 @@ Please be careful that the size of the request exceeds the limit. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -1718,7 +1719,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## MultiLinearSearchByID RPC MultiLinearSearchByID RPC is the method to linear search vectors with multiple IDs in **1** request. @@ -1761,7 +1761,7 @@ Please be careful that the size of the request exceeds the limit. repeated Filter.Target targets = 1; } - enum Search.AggregationAlgorithm { + enum Search.AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; @@ -1778,46 +1778,46 @@ Please be careful that the size of the request exceeds the limit. - Search.MultiIDRequest - | field | type | label | description | - | :------: | :--------------- | :------- | :--------------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Search.IDRequest | repeated | Represent the multiple search by ID request content. | - Search.IDRequest - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | id | string | | The vector ID to be searched. | - | config | Search.Config | | The configuration of the search request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID to be searched. | + | config | Search.Config | | The configuration of the search request. | - Search.Config - | field | type | label | description | - | :-------------------: | :-------------------------- | :---- | :------------------------------------------- | - | request_id | string | | Unique request ID. | - | num | uint32 | | Maximum number of result to be returned. | - | radius | float | | Search radius. | - | epsilon | float | | Search coefficient. | - | timeout | int64 | | Search timeout in nanoseconds. | - | ingress_filters | Filter.Config | | Ingress filter configurations. | - | egress_filters | Filter.Config | | Egress filter configurations. | - | min_num | uint32 | | Minimum number of result to be returned. | - | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | - | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | - | nprobe | uint32 | | Search nprobe. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | Unique request ID. | + | num | uint32 | | Maximum number of result to be returned. | + | radius | float | | Search radius. | + | epsilon | float | | Search coefficient. | + | timeout | int64 | | Search timeout in nanoseconds. | + | ingress_filters | Filter.Config | | Ingress filter configurations. | + | egress_filters | Filter.Config | | Egress filter configurations. | + | min_num | uint32 | | Minimum number of result to be returned. | + | aggregation_algorithm | Search.AggregationAlgorithm | | Aggregation Algorithm | + | ratio | google.protobuf.FloatValue | | Search ratio for agent return result number. | + | nprobe | uint32 | | Search nprobe. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | + - Filter.Target + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Search.Responses` @@ -1841,23 +1841,23 @@ Please be careful that the size of the request exceeds the limit. - Search.Responses - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | responses | Search.Response | repeated | Represent the multiple search response content. | - Search.Response - | field | type | label | description | - | :--------: | :-------------- | :------- | :--------------------- | - | request_id | string | | The unique request ID. | - | results | Object.Distance | repeated | Search results. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | request_id | string | | The unique request ID. | + | results | Object.Distance | repeated | Search results. | - Object.Distance - | field | type | label | description | - | :------: | :----- | :---- | :------------- | - | id | string | | The vector ID. | - | distance | float | | The distance. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | distance | float | | The distance. | ### Status Code @@ -1873,6 +1873,7 @@ Please be careful that the size of the request exceeds the limit. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. diff --git a/apis/docs/v1/update.md b/apis/docs/v1/update.md index 4ecee8eb3d..66976fc014 100644 --- a/apis/docs/v1/update.md +++ b/apis/docs/v1/update.md @@ -55,43 +55,41 @@ Update RPC is the method to update a single vector. - Update.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | vector | Object.Vector | | The vector to be updated. | - | config | Update.Config | | The configuration of the update request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector to be updated. | + | config | Update.Config | | The configuration of the update request. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | - Update.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Update timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Update timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.Location` @@ -107,11 +105,11 @@ Update RPC is the method to update a single vector. - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -128,6 +126,7 @@ Update RPC is the method to update a single vector. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -142,7 +141,6 @@ Here are some common reasons and how to resolve each error. | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## StreamUpdate RPC StreamUpdate RPC is the method to update multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
@@ -186,43 +184,41 @@ It's the recommended method to update the large amount of vectors. - Update.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | vector | Object.Vector | | The vector to be updated. | - | config | Update.Config | | The configuration of the update request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector to be updated. | + | config | Update.Config | | The configuration of the update request. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | - Update.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Update timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Update timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.StreamLocation` @@ -243,18 +239,18 @@ It's the recommended method to update the large amount of vectors. - Object.StreamLocation - | field | type | label | description | - | :------: | :---------------- | :---- | :-------------------- | - | location | Object.Location | | The vector location. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | location | Object.Location | | The vector location. | + | status | google.rpc.Status | | The RPC error status. | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -271,6 +267,7 @@ It's the recommended method to update the large amount of vectors. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -285,7 +282,6 @@ Here are some common reasons and how to resolve each error. | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## MultiUpdate RPC MultiUpdate is the method to update multiple vectors in **1** request. @@ -335,49 +331,47 @@ Please be careful that the size of the request exceeds the limit. - Update.MultiRequest - | field | type | label | description | - | :------: | :------------- | :------- | :--------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Update.Request | repeated | Represent the multiple update request content. | - Update.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | vector | Object.Vector | | The vector to be updated. | - | config | Update.Config | | The configuration of the update request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector to be updated. | + | config | Update.Config | | The configuration of the update request. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | - Update.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Update timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during update operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Update timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.Locations` @@ -397,17 +391,17 @@ Please be careful that the size of the request exceeds the limit. - Object.Locations - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------- | - | locations | Object.Location | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | locations | Object.Location | repeated | | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -424,6 +418,7 @@ Please be careful that the size of the request exceeds the limit. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -438,7 +433,6 @@ Here are some common reasons and how to resolve each error. | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## UpdateTimestamp RPC A method to update timestamp an indexed vector. @@ -458,12 +452,11 @@ A method to update timestamp an indexed vector. - Update.TimestampRequest - | field | type | label | description | - | :-------: | :----- | :---- | :------------------------------------------------ | - | id | string | | The vector ID. | - | timestamp | int64 | | timestamp represents when this vector inserted. | - | force | bool | | force represents forcefully update the timestamp. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | timestamp | int64 | | timestamp represents when this vector inserted. | + | force | bool | | force represents forcefully update the timestamp. | ### Output - the scheme of `payload.v1.Object.Location` @@ -479,21 +472,21 @@ A method to update timestamp an indexed vector. - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code -| code | description | -| :--: | :---------- | - +| code | description | +| :--: | :---------------- | TODO Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting TODO diff --git a/apis/docs/v1/upsert.md b/apis/docs/v1/upsert.md index 13de9925b2..78312f7b36 100644 --- a/apis/docs/v1/upsert.md +++ b/apis/docs/v1/upsert.md @@ -54,43 +54,41 @@ Upsert RPC is the method to update the inserted vector to a new single vector or - Upsert.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | vector | Object.Vector | | The vector to be upserted. | - | config | Upsert.Config | | The configuration of the upsert request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector to be upserted. | + | config | Upsert.Config | | The configuration of the upsert request. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | - Upsert.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Upsert timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Upsert timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.Location` @@ -106,11 +104,11 @@ Upsert RPC is the method to update the inserted vector to a new single vector or - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -127,6 +125,7 @@ Upsert RPC is the method to update the inserted vector to a new single vector or Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -140,7 +139,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## StreamUpsert RPC StreamUpsert RPC is the method to update multiple existing vectors or add new multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
@@ -184,43 +182,41 @@ It’s the recommended method to upsert a large number of vectors. - Upsert.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | vector | Object.Vector | | The vector to be upserted. | - | config | Upsert.Config | | The configuration of the upsert request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector to be upserted. | + | config | Upsert.Config | | The configuration of the upsert request. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | - Upsert.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Upsert timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Upsert timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.StreamLocation` @@ -241,18 +237,18 @@ It’s the recommended method to upsert a large number of vectors. - Object.StreamLocation - | field | type | label | description | - | :------: | :---------------- | :---- | :-------------------- | - | location | Object.Location | | The vector location. | - | status | google.rpc.Status | | The RPC error status. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | location | Object.Location | | The vector location. | + | status | google.rpc.Status | | The RPC error status. | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -269,6 +265,7 @@ It’s the recommended method to upsert a large number of vectors. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. @@ -282,7 +279,6 @@ Here are some common reasons and how to resolve each error. | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - ## MultiUpsert RPC MultiUpsert is the method to update existing multiple vectors and add new multiple vectors in **1** request. @@ -332,49 +328,47 @@ Please be careful that the size of the request exceeds the limit. - Upsert.MultiRequest - | field | type | label | description | - | :------: | :------------- | :------- | :--------------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | requests | Upsert.Request | repeated | Represent the multiple upsert request content. | - Upsert.Request - | field | type | label | description | - | :----: | :------------ | :---- | :--------------------------------------- | - | vector | Object.Vector | | The vector to be upserted. | - | config | Upsert.Config | | The configuration of the upsert request. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | vector | Object.Vector | | The vector to be upserted. | + | config | Upsert.Config | | The configuration of the upsert request. | - Object.Vector - | field | type | label | description | - | :-------: | :----- | :------- | :---------------------------------------------- | - | id | string | | The vector ID. | - | vector | float | repeated | The vector. | - | timestamp | int64 | | timestamp represents when this vector inserted. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | id | string | | The vector ID. | + | vector | float | repeated | The vector. | + | timestamp | int64 | | timestamp represents when this vector inserted. | - Upsert.Config - | field | type | label | description | - | :---: | :--- | :---- | :---------- | - | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | - | filters | Filter.Config | | Filter configuration. | - | timestamp | int64 | | Upsert timestamp. | - | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) - - during update operation. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | skip_strict_exist_check | bool | | A flag to skip exist check during upsert operation. | + | filters | Filter.Config | | Filter configuration. | + | timestamp | int64 | | Upsert timestamp. | + | disable_balanced_update | bool | | A flag to disable balanced update (split remove -> insert operation) +during update operation. | - Filter.Config - | field | type | label | description | - | :-----: | :------------ | :------- | :----------------------------------------- | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | | targets | Filter.Target | repeated | Represent the filter target configuration. | - Filter.Target - | field | type | label | description | - | :---: | :----- | :---- | :------------------- | - | host | string | | The target hostname. | - | port | uint32 | | The target port. | - + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | host | string | | The target hostname. | + | port | uint32 | | The target port. | ### Output - the scheme of `payload.v1.Object.Locations` @@ -394,17 +388,17 @@ Please be careful that the size of the request exceeds the limit. - Object.Locations - | field | type | label | description | - | :-------: | :-------------- | :------- | :---------- | - | locations | Object.Location | repeated | | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | locations | Object.Location | repeated | | - Object.Location - | field | type | label | description | - | :---: | :----- | :------- | :------------------------ | - | name | string | | The name of the location. | - | uuid | string | | The UUID of the vector. | - | ips | string | repeated | The IP list. | + | field | type | label | description | + | :---: | :--- | :---- | :---------- | + | name | string | | The name of the location. | + | uuid | string | | The UUID of the vector. | + | ips | string | repeated | The IP list. | ### Status Code @@ -421,6 +415,7 @@ Please be careful that the size of the request exceeds the limit. Please refer to [Response Status Code](../status.md) for more details. + ### Troubleshooting The request process may not be completed when the response code is NOT `0 (OK)`. diff --git a/apis/proto/v1/mirror/mirror.proto b/apis/proto/v1/mirror/mirror.proto index 5275ceb2eb..d5059269de 100644 --- a/apis/proto/v1/mirror/mirror.proto +++ b/apis/proto/v1/mirror/mirror.proto @@ -25,9 +25,18 @@ option java_multiple_files = true; option java_outer_classname = "ValdMirror"; option java_package = "org.vdaas.vald.api.v1.mirror"; -// Represent the mirror service. +// Overview +// Mirror Service is responsible for providing the `Register` interface for the Vald Mirror Gateway. service Mirror { - // Register is the RPC to register other mirror servers. + // Overview + // Register RPC is the method to register other Vald Mirror Gateway targets. + // --- + // Status Code + // | 0 | OK | + // | 1 | CANCELLED | + // | 3 | INVALID_ARGUMENT | + // | 4 | DEADLINE_EXCEEDED | + // | 13 | INTERNAL | rpc Register(payload.v1.Mirror.Targets) returns (payload.v1.Mirror.Targets) { option (google.api.http) = { post: "/mirror/register"