diff --git a/docs/api/insert.md b/docs/api/insert.md index a02edea5a30..5ccd3a73936 100644 --- a/docs/api/insert.md +++ b/docs/api/insert.md @@ -45,23 +45,26 @@ Inset RPC is the method to add a new single vector. ``` - Insert.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|Object.Vector| | \* | the information of vector | - |config|Config| | \* | the configuration of the insert request | + + | field | type | label | required | desc. | + | :----: | :------------ | :---- | :------: | :-------------------------------------- | + | vector | Object.Vector | | \* | the information of vector | + | config | Config | | \* | the configuration of the insert request | - Insert.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector inserted.
if it is N/A, the current time will be used. | - |filters|Filter.Config| | | configuration for filter | + + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector inserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | - Object.Vector - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | ### Output @@ -78,11 +81,12 @@ Inset RPC is the method to add a new single vector. ``` - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is inserted. | - |uuid|string| | the ID of the inserted vector. It is the same as an `Object.Vector`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is inserted. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :--------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is inserted. | + | uuid | string | | the ID of the inserted vector. It is the same as an `Object.Vector`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is inserted. | ### Status Code @@ -126,23 +130,26 @@ It's the recommended method to insert the large amount of vectors. ``` - Insert.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|Object.Vector| | \* | the information of vector | - |config|Config| | \* | the configuration of the insert request | + + | field | type | label | required | desc. | + | :----: | :------------ | :---- | :------: | :-------------------------------------- | + | vector | Object.Vector | | \* | the information of vector | + | config | Config | | \* | the configuration of the insert request | - Insert.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector inserted.
if it is N/A, the current time will be used. | - |filters|Filter.Config| | | configuration for filter | + + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector inserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | - Object.Vector - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of the vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :--------------------------------------------------------------- | + | id | string | | \* | the ID of the vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | ### Output @@ -166,24 +173,27 @@ It's the recommended method to insert the large amount of vectors. ``` - Object.StreamLocation - |field|type|label|desc.| - |:---:|:---|:---|:---| - |location|Object.Location| | the information of `Object.Location` data. | - |status|google.rpc.Status| | the status of google RPC. | + + | field | type | label | desc. | + | :------: | :---------------- | :---- | :----------------------------------------- | + | location | Object.Location | | the information of `Object.Location` data. | + | status | google.rpc.Status | | the status of google RPC. | - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is inserted. | - |uuid|string| | the ID of the inserted vector. It is the same as an `Object.Vector`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is inserted. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :--------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is inserted. | + | uuid | string | | the ID of the inserted vector. It is the same as an `Object.Vector`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is inserted. | - [google.rpc.Status](https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto) - |field|type|label|desc.| - |:---:|:---|:---|:---| - |code|int32| | status code (code list is next section)| - |message|string| | error message | - |details|google.protobuf.Any| repeated(Array[any]) | the details error message list| + + | field | type | label | desc. | + | :-----: | :------------------ | :------------------- | :-------------------------------------- | + | code | int32 | | status code (code list is next section) | + | message | string | | error message | + | details | google.protobuf.Any | repeated(Array[any]) | the details error message list | ### Status Code @@ -232,28 +242,32 @@ Please be careful that the size of the request exceed the limit. ``` - Insert.MultiRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |requests|Insert.Request| repeated(Array[Insert.Request]) | \* | the request list | + + | field | type | label | required | desc. | + | :------: | :------------- | :------------------------------ | :------: | :--------------- | + | requests | Insert.Request | repeated(Array[Insert.Request]) | \* | the request list | - Insert.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|Object.Vector| | \* | the information of vector | - |config|Config| | \* | the configuration of the insert request | + + | field | type | label | required | desc. | + | :----: | :------------ | :---- | :------: | :-------------------------------------- | + | vector | Object.Vector | | \* | the information of vector | + | config | Config | | \* | the configuration of the insert request | - Insert.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector inserted.
if it is N/A, the current time will be used. | - |filters|Filter.Config| | | configuration for filter | + + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector inserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | - Object.Vector - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | ### Output @@ -272,16 +286,18 @@ Please be careful that the size of the request exceed the limit. ``` - Object.Locations - |field|type|label|desc.| - |:---:|:---|:---|:---| - |location|Object.Location| repeated(Array[Object.Location]) | the list of `Object.Location`. | + + | field | type | label | desc. | + | :------: | :-------------- | :------------------------------- | :----------------------------- | + | location | Object.Location | repeated(Array[Object.Location]) | the list of `Object.Location`. | - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is inserted. | - |uuid|string| | the ID of the inserted vector. It is the same as an `Object.Vector`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is inserted. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :--------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is inserted. | + | uuid | string | | the ID of the inserted vector. It is the same as an `Object.Vector`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is inserted. | ### Status Code diff --git a/docs/api/object.md b/docs/api/object.md index f02a459e9e9..36dd3d82e48 100644 --- a/docs/api/object.md +++ b/docs/api/object.md @@ -33,9 +33,10 @@ Exists RPC is the method to check the a vector exists in the `vald-agent`. ``` - Object.ID - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | + + | field | type | label | required | desc. | + | :---: | :----- | :---- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | ### Output @@ -50,18 +51,20 @@ Exists RPC is the method to check the a vector exists in the `vald-agent`. ``` - Object.ID - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the ID of a vector. ID should consist of 1 or more characters. | + + | field | type | label | desc. | + | :---: | :----- | :---- | :------------------------------------------------------------- | + | id | string | | the ID of a vector. ID should consist of 1 or more characters. | ### Status Code -| code | desc. | -| :--: | :--------------- | -| 0 | OK | -| 3 | INVALID_ARGUMENT | -| 5 | NOT_FOUND | -| 13 | INTERNAL | +| code | desc. | +| :--: | :---------------- | +| 0 | OK | +| 3 | INVALID_ARGUMENT | +| 4 | DEADLINE_EXCEEDED | +| 5 | NOT_FOUND | +| 13 | INTERNAL | ## GetObject RPC @@ -85,15 +88,17 @@ GetObject RPC is the method to get the metadata of a vector inserted into the `v ``` - Object.VectorRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|Object.ID| | \* | the ID of a vector. ID should consist of 1 or more characters. | - |filters|Filter.Config| | | configuration for filter. | + + | field | type | label | required | desc. | + | :-----: | :------------ | :---- | :------: | :------------------------------------------------------------- | + | id | Object.ID | | \* | the ID of a vector. ID should consist of 1 or more characters. | + | filters | Filter.Config | | | configuration for filter. | - Object.ID - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | + + | field | type | label | required | desc. | + | :---: | :----- | :---- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | ### Output @@ -109,10 +114,11 @@ GetObject RPC is the method to get the metadata of a vector inserted into the `v ``` - Object.Vector - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the ID of a vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | the vector data. its dimension is between 2 and 65,536. | + + | field | type | label | desc. | + | :----: | :----- | :--------------------- | :------------------------------------------------------------- | + | id | string | | the ID of a vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | the vector data. its dimension is between 2 and 65,536. | ### Status Code @@ -145,15 +151,17 @@ Each Upsert request and response are independent. ``` - Object.VectorRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|Object.ID| | \* | the ID of a vector. ID should consist of 1 or more characters. | - |filters|Filter.Config| | | configuration for filter. | + + | field | type | label | required | desc. | + | :-----: | :------------ | :---- | :------: | :------------------------------------------------------------- | + | id | Object.ID | | \* | the ID of a vector. ID should consist of 1 or more characters. | + | filters | Filter.Config | | | configuration for filter. | - Object.ID - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | + + | field | type | label | required | desc. | + | :---: | :----- | :---- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | ### Output @@ -175,16 +183,18 @@ Each Upsert request and response are independent. ``` - Object.StreamVector - |field|type|label|desc.| - |:---:|:---|:---|:---| - |vector|Vector| | the information of Object.Vector data. | - |status|google.rpc.Status| | the status of google RPC. | + + | field | type | label | desc. | + | :----: | :---------------- | :---- | :------------------------------------- | + | vector | Vector | | the information of Object.Vector data. | + | status | google.rpc.Status | | the status of google RPC. | - Object.Vector - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the ID of a vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | the vector data. its dimension is between 2 and 65,536. | + + | field | type | label | desc. | + | :----: | :----- | :--------------------- | :------------------------------------------------------------- | + | id | string | | the ID of a vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | the vector data. its dimension is between 2 and 65,536. | ### Status Code @@ -194,4 +204,3 @@ Each Upsert request and response are independent. | 3 | INVALID_ARGUMENT | | 5 | NOT_FOUND | | 13 | INTERNAL | - diff --git a/docs/api/remove.md b/docs/api/remove.md index d588fe48faf..06cb28815d6 100644 --- a/docs/api/remove.md +++ b/docs/api/remove.md @@ -46,21 +46,24 @@ Remove RPC is the method to remove a single vector. ``` - Remove.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|Object.ID| | \* | the id of vector | - |config|Config| | \* | the configuration of the remove request | + + | field | type | label | required | desc. | + | :----: | :-------- | :---- | :------: | :-------------------------------------- | + | id | Object.ID | | \* | the id of vector | + | config | Config | | \* | the configuration of the remove request | - Remove.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector removed.
if it is N/A, the current time will be used. | + + | field | type | label | required | desc. | + | :---------------------: | :---- | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector removed.
if it is N/A, the current time will be used. | - Object.ID - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | + + | field | type | label | required | desc. | + | :---: | :----- | :---- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | ### Output @@ -77,20 +80,22 @@ Remove RPC is the method to remove a single vector. ``` - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is removed. | - |uuid|string| | the ID of the removed vector. It is the same as an `Object.ID`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is removed. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :-------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is removed. | + | uuid | string | | the ID of the removed vector. It is the same as an `Object.ID`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is removed. | ### Status Code -| code | desc. | -| :--: | :--------------- | -| 0 | OK | -| 3 | INVALID_ARGUMENT | -| 5 | NOT_FOUND | -| 13 | INTERNAL | +| code | desc. | +| :--: | :---------------- | +| 0 | OK | +| 3 | INVALID_ARGUMENT | +| 4 | DEADLINE_EXCEEDED | +| 5 | NOT_FOUND | +| 13 | INTERNAL | ## StreamRemove RPC @@ -124,21 +129,24 @@ It's the recommended method to remove the large amount of vectors. ``` - Remove.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|Object.ID| | \* | the id of vector | - |config|Config| | \* | the configuration of the insert request | + + | field | type | label | required | desc. | + | :----: | :-------- | :---- | :------: | :-------------------------------------- | + | id | Object.ID | | \* | the id of vector | + | config | Config | | \* | the configuration of the insert request | - Remove.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector removed.
if it is N/A, the current time will be used. | + + | field | type | label | required | desc. | + | :---------------------: | :---- | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector removed.
if it is N/A, the current time will be used. | - Object.ID - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | + + | field | type | label | required | desc. | + | :---: | :----- | :---- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | ### Output @@ -162,33 +170,37 @@ It's the recommended method to remove the large amount of vectors. ``` - Object.StreamLocation - |field|type|label|desc.| - |:---:|:---|:---|:---| - |location|Object.Location| | the information of `Object.Location` data. | - |status|google.rpc.Status| | the status of google RPC | + + | field | type | label | desc. | + | :------: | :---------------- | :---- | :----------------------------------------- | + | location | Object.Location | | the information of `Object.Location` data. | + | status | google.rpc.Status | | the status of google RPC | - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is removed. | - |uuid|string| | the ID of the removed vector. It is the same as an `Object.ID`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is removed. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :-------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is removed. | + | uuid | string | | the ID of the removed vector. It is the same as an `Object.ID`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is removed. | - [google.rpc.Status](https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto) - |field|type|label|desc.| - |:---:|:---|:---|:---| - |code|int32| | status code (code list is next section) | - |message|string| | error message | - |details|google.protobuf.Any| repeated(Array[any]) | the details error message list | + + | field | type | label | desc. | + | :-----: | :------------------ | :------------------- | :-------------------------------------- | + | code | int32 | | status code (code list is next section) | + | message | string | | error message | + | details | google.protobuf.Any | repeated(Array[any]) | the details error message list | ### Status Code -| code | desc. | -| :--: | :--------------- | -| 0 | OK | -| 3 | INVALID_ARGUMENT | -| 5 | NOT_FOUND | -| 13 | INTERNAL | +| code | desc. | +| :--: | :---------------- | +| 0 | OK | +| 3 | INVALID_ARGUMENT | +| 4 | DEADLINE_EXCEEDED | +| 5 | NOT_FOUND | +| 13 | INTERNAL | ## MultiRemove RPC @@ -228,26 +240,30 @@ Please be careful that the size of the request exceed the limit. ``` - Remove.MultiRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |requests|Remove.Request| repeated(Array[Insert.Request]) | \* | the request list | + + | field | type | label | required | desc. | + | :------: | :------------- | :------------------------------ | :------: | :--------------- | + | requests | Remove.Request | repeated(Array[Insert.Request]) | \* | the request list | - Remove.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|Object.ID| | \* | the id of vector | - |config|Config| | \* | the configuration of the remove request | + + | field | type | label | required | desc. | + | :----: | :-------- | :---- | :------: | :-------------------------------------- | + | id | Object.ID | | \* | the id of vector | + | config | Config | | \* | the configuration of the remove request | - Remove.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector removed.
if it is N/A, the current time will be used. | + + | field | type | label | required | desc. | + | :---------------------: | :---- | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector removed.
if it is N/A, the current time will be used. | - Object.ID - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | + + | field | type | label | required | desc. | + | :---: | :----- | :---- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | ### Output @@ -266,22 +282,25 @@ Please be careful that the size of the request exceed the limit. ``` - Object.Locations - |field|type|label|desc.| - |:---:|:---|:---|:---| - |location|Object.Location| repeated(Array[Object.Location]) | the list of `Object.Location`. | + + | field | type | label | desc. | + | :------: | :-------------- | :------------------------------- | :----------------------------- | + | location | Object.Location | repeated(Array[Object.Location]) | the list of `Object.Location`. | - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is removed. | - |uuid|string| | the ID of the removed vector. It is the same as an `Object.Vector`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is removed. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :-------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is removed. | + | uuid | string | | the ID of the removed vector. It is the same as an `Object.Vector`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is removed. | ### Status Code -| code | desc. | -| :--: | :--------------- | -| 0 | OK | -| 3 | INVALID_ARGUMENT | -| 5 | NOT_FOUND | -| 13 | INTERNAL | +| code | desc. | +| :--: | :---------------- | +| 0 | OK | +| 3 | INVALID_ARGUMENT | +| 4 | DEADLINE_EXCEEDED | +| 5 | NOT_FOUND | +| 13 | INTERNAL | diff --git a/docs/api/search.md b/docs/api/search.md index ef3b704bee1..27227f0a173 100644 --- a/docs/api/search.md +++ b/docs/api/search.md @@ -70,22 +70,24 @@ Search RPC is the method to search vector(s) similar to request vector. ``` - Search.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------ | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |radius|float| | \* | the search radius | - |epsilon|float| | \* | the search coefficient (default value is `0.1`) | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | radius | float | | \* | the search radius | + | epsilon | float | | \* | the search coefficient (default value is `0.1`) | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -108,16 +110,18 @@ Search RPC is the method to search vector(s) similar to request vector. ``` - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -157,22 +161,24 @@ The vector with the same requested ID should be indexed into the `vald-agent` be ``` - Search.IDRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the vector ID to be searched | - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :---- | :------: | :-------------------------------------- | + | id | string | | \* | the vector ID to be searched | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |radius|float| | \* | the search radius | - |epsilon|float| | \* | the search coefficient (default value is `0.1`) | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | radius | float | | \* | the search radius | + | epsilon | float | | \* | the search coefficient (default value is `0.1`) | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -195,16 +201,18 @@ The vector with the same requested ID should be indexed into the `vald-agent` be ``` - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -245,22 +253,24 @@ Each Search request and response are independent. ``` - Search.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------ | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |radius|float| | \* | the search radius | - |epsilon|float| | \* | the search coefficient (default value is `0.1`) | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | radius | float | | \* | the search radius | + | epsilon | float | | \* | the search coefficient (default value is `0.1`) | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -290,22 +300,25 @@ Each Search request and response are independent. ``` - Search.StreamResponse - |field|type|label|desc.| - |:---:|:---|:---|:---| - |response|Response| | the search result response | - |status|google.rpc.Status| | the status of google RPC | + + | field | type | label | desc. | + | :------: | :---------------- | :---- | :------------------------- | + | response | Response | | the search result response | + | status | google.rpc.Status | | the status of google RPC | - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -346,22 +359,24 @@ Each SearchByID request and response are independent. ``` - Search.IDRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the vector ID to be searched | - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :---- | :------: | :-------------------------------------- | + | id | string | | \* | the vector ID to be searched | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |radius|float| | \* | the search radius | - |epsilon|float| | \* | the search coefficient (default value is `0.1`) | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | radius | float | | \* | the search radius | + | epsilon | float | | \* | the search coefficient (default value is `0.1`) | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -391,22 +406,25 @@ Each SearchByID request and response are independent. ``` - Search.StreamResponse - |field|type|label|desc.| - |:---:|:---|:---|:---| - |response|Response| | the search result response | - |status|google.rpc.Status| | the status of google RPC | + + | field | type | label | desc. | + | :------: | :---------------- | :---- | :------------------------- | + | response | Response | | the search result response | + | status | google.rpc.Status | | the status of google RPC | - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -454,27 +472,30 @@ Please be careful that the size of the request exceed the limit. ``` - Search.MultiRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |requests| repeated(Array[Request]) | | \* | the search request list | + + | field | type | label | required | desc. | + | :------: | :----------------------- | :---- | :------: | :---------------------- | + | requests | repeated(Array[Request]) | | \* | the search request list | - Search.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------ | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |radius|float| | \* | the search radius | - |epsilon|float| | \* | the search coefficient (default value is `0.1`) | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | radius | float | | \* | the search radius | + | epsilon | float | | \* | the search coefficient (default value is `0.1`) | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -501,21 +522,24 @@ Please be careful that the size of the request exceed the limit. ``` - Search.Responses - |field|type|label|desc.| - |:---:|:---|:---|:---| - |responses| Response | repeated(Array[Response]) | the list of search results response | + + | field | type | label | desc. | + | :-------: | :------- | :------------------------ | :---------------------------------- | + | responses | Response | repeated(Array[Response]) | the list of search results response | - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -564,27 +588,30 @@ Please be careful that the size of the request exceed the limit. ``` - Search.MultiIDRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |requests|IDRequest| repeated(Array[IDRequest]) | \* | the searchByID request list | + + | field | type | label | required | desc. | + | :------: | :-------- | :------------------------- | :------: | :-------------------------- | + | requests | IDRequest | repeated(Array[IDRequest]) | \* | the searchByID request list | - Search.IDRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the vector ID to be searched | - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :---- | :------: | :-------------------------------------- | + | id | string | | \* | the vector ID to be searched | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |radius|float| | \* | the search radius | - |epsilon|float| | \* | the search coefficient (default value is `0.1`) | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | radius | float | | \* | the search radius | + | epsilon | float | | \* | the search coefficient (default value is `0.1`) | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -611,21 +638,24 @@ Please be careful that the size of the request exceed the limit. ``` - Search.Responses - |field|type|label|desc.| - |:---:|:---|:---|:---| - |responses| Response | repeated(Array[Response]) | the list of search results response | + + | field | type | label | desc. | + | :-------: | :------- | :------------------------ | :---------------------------------- | + | responses | Response | repeated(Array[Response]) | the list of search results response | - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -662,20 +692,22 @@ LinearSearch RPC is the method to linear search vector(s) similar to request vec ``` - Search.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------ | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -698,16 +730,18 @@ LinearSearch RPC is the method to linear search vector(s) similar to request vec ``` - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -746,20 +780,22 @@ If the vector doesn't be stored, you will get a `NOT_FOUND` error as a result. ``` - Search.IDRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the vector ID to be searched | - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :---- | :------: | :-------------------------------------- | + | id | string | | \* | the vector ID to be searched | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -782,16 +818,18 @@ If the vector doesn't be stored, you will get a `NOT_FOUND` error as a result. ``` - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -830,20 +868,22 @@ Each LinearSearch request and response are independent. ``` - Search.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------ | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -873,22 +913,25 @@ Each LinearSearch request and response are independent. ``` - Search.StreamResponse - |field|type|label|desc.| - |:---:|:---|:---|:---| - |response|Response| | the search result response | - |status|google.rpc.Status| | the status of google RPC | + + | field | type | label | desc. | + | :------: | :---------------- | :---- | :------------------------- | + | response | Response | | the search result response | + | status | google.rpc.Status | | the status of google RPC | - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -927,20 +970,22 @@ Each LinearSearchByID request and response are independent. ``` - Search.IDRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the vector ID to be searched | - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :---- | :------: | :-------------------------------------- | + | id | string | | \* | the vector ID to be searched | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -970,22 +1015,25 @@ Each LinearSearchByID request and response are independent. ``` - Search.StreamResponse - |field|type|label|desc.| - |:---:|:---|:---|:---| - |response|Response| | the search result response | - |status|google.rpc.Status| | the status of google RPC | + + | field | type | label | desc. | + | :------: | :---------------- | :---- | :------------------------- | + | response | Response | | the search result response | + | status | google.rpc.Status | | the status of google RPC | - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -1031,25 +1079,28 @@ Please be careful that the size of the request exceed the limit. ``` - Search.MultiRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |requests| repeated(Array[Request]) | | \* | the search request list | + + | field | type | label | required | desc. | + | :------: | :----------------------- | :---- | :------: | :---------------------- | + | requests | repeated(Array[Request]) | | \* | the search request list | - Search.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------ | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -1076,21 +1127,24 @@ Please be careful that the size of the request exceed the limit. ``` - Search.Responses - |field|type|label|desc.| - |:---:|:---|:---|:---| - |responses| Response | repeated(Array[Response]) | the list of search results response | + + | field | type | label | desc. | + | :-------: | :------- | :------------------------ | :---------------------------------- | + | responses | Response | repeated(Array[Response]) | the list of search results response | - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code @@ -1137,25 +1191,28 @@ Please be careful that the size of the request exceed the limit. ``` - Search.MultiIDRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |requests|IDRequest| repeated(Array[IDRequest]) | \* | the searchByID request list | + + | field | type | label | required | desc. | + | :------: | :-------- | :------------------------- | :------: | :-------------------------- | + | requests | IDRequest | repeated(Array[IDRequest]) | \* | the searchByID request list | - Search.IDRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the vector ID to be searched.| - |config|Config| | \* | the configuration of the search request | + + | field | type | label | required | desc. | + | :----: | :----- | :---- | :------: | :-------------------------------------- | + | id | string | | \* | the vector ID to be searched. | + | config | Config | | \* | the configuration of the search request | - Search.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |request_id|string| | | unique request ID | - |num|uint32| | \* | the maximum number of result to be returned | - |timeout|int64| | | Search timeout in nanoseconds (default value is `5s`) | - |ingress_filters|Filter.Config| | | Ingress Filter configuration | - |egress_filters|Filter.Config| | | Egress Filter configuration | - |min_num| uint32 | | the minimum number of result to be returned | + + | field | type | label | required | desc. | + | :-------------: | :------------ | :---- | :-----------------------------------------: | :---------------------------------------------------- | + | request_id | string | | | unique request ID | + | num | uint32 | | \* | the maximum number of result to be returned | + | timeout | int64 | | | Search timeout in nanoseconds (default value is `5s`) | + | ingress_filters | Filter.Config | | | Ingress Filter configuration | + | egress_filters | Filter.Config | | | Egress Filter configuration | + | min_num | uint32 | | the minimum number of result to be returned | ### Output @@ -1182,21 +1239,24 @@ Please be careful that the size of the request exceed the limit. ``` - Search.Responses - |field|type|label|desc.| - |:---:|:---|:---|:---| - |responses| Response | repeated(Array[Response]) | the list of search results response | + + | field | type | label | desc. | + | :-------: | :------- | :------------------------ | :---------------------------------- | + | responses | Response | repeated(Array[Response]) | the list of search results response | - Search.Response - |field|type|label|desc.| - |:---:|:---|:---|:---| - |request_id|string| | the unique request ID | - |results|Object.Distance| repeated(Array[Object.Distance]) | search results | + + | field | type | label | desc. | + | :--------: | :-------------- | :------------------------------- | :-------------------- | + | request_id | string | | the unique request ID | + | results | Object.Distance | repeated(Array[Object.Distance]) | search results | - Object.Distance - |field|type|label|desc.| - |:---:|:---|:---|:---| - |id|string| | the vector ID | - |distance|float| | the distance between result vector and request vector | + + | field | type | label | desc. | + | :------: | :----- | :---- | :---------------------------------------------------- | + | id | string | | the vector ID | + | distance | float | | the distance between result vector and request vector | ### Status Code diff --git a/docs/api/status.md b/docs/api/status.md new file mode 100644 index 00000000000..b82ebb1082d --- /dev/null +++ b/docs/api/status.md @@ -0,0 +1,98 @@ +# Response Status Code + +This page describes each status code from API response. + +## Status Codes + +This table shows the main status code and its name using Vald. +Below sections describes the meaning of each code and the reason why API returns. + +| code | name | +| :--: | :---------------------------------------- | +| 0 | [OK](#OK) | +| 3 | [INVALID_ARGUMENT](#INVALID_ARGUMENT) | +| 4 | [DEADLINE_EXCEEDED](#DEADLINE_EXCEEDED) | +| 5 | [NOT_FOUND](#NOT_FOUND) | +| 6 | [ALREADY_EXISTS](#ALREADY_EXISTS) | +| 8 | [RESOURCE_EXHAUSTED](#RESOURCE_EXHAUSTED) | +| 13 | [INTERNAL](#INTERNAL) | +| 14 | [UNAVAILABLE](#UNAVAILABLE) | + +## OK + +`OK` means complete process with success. + +Services that return this code are all services. + +## INVALID_ARGUMENT + +`INVALID_ARGUMENT` means the something wrong in the request configuration. + +Services that return status are all services. +If you get this code, please verify your request is correct. + +## DEADLINE_EXCEEDED + +`DEADLINE_EXCEEDED` returns when the process ends due to timeout. + +Services that returns status are: +- [Object Service(only Exists RPC)](../api/object.md#Exists-RPC) +- [Insert Service](../api/insert.md) +- [Remove Service](../api/insert.md) +- [Search Service](../api/search.md) + +The timeout configuration is on the Vald cluster side. +If it appears constantly, you need to review the cluster settings. +However, it appears only when using search service, you can overwrite timeout configuration by lengthening the time setting in the search config. + +## NOT_FOUND + +`NOT_FOUND` appears when there is no result corresponding to the request. + +The example cases are: + + - No search result when using SearchById api + - No index data corresponding to the request vector when using Update/Exists/GetObject api + +Services that returns status are: +- [Object Service](../api/object.md) +- [Update Service](../api/update.md) +- [Remove Service](../api/insert.md) +- [Search Service](../api/search.md) + +There are two reasons. +One is there is no index data in Vald Agent components or index process is running in. +When Vald Agent component runs the index process (createIndex/saveIndex), the any process won't run and it will return with no result. + +The other one, which occurs using search / update / remove service, is the request query vector or id is wrong. +Especially, both of update service and remove service requires the ID of vector Vald Agent component already indexed. + +## ALREADY_EXISTS + +`ALREADY_EXISTS` means that Vald Agent component already index the vector same as the query vector when set `skip_strict_exist_check` as `true` in request config. + +Services that returns status are: +- [Insert Service](../api/insert.md) +- [Update Service](../api/update.md) + +The way to avoid it, you have to change the query vector with `skip_strict_exist_check` is `true` or set `skip_strict_exist_check` as `false` instead of change the query vector. + +## RESOURCE_EXHAUSTED + +`RESOURCE_EXHAUSTED` means the gRPC message size is bigger than limit (default is 4MB). + +Services that returns status are all services. +The most case in the Vald is the query vector is too large in other word setting vector dimension size it too large. + +## INTERNAL + +`INTERNAL` appears when some wrong happens in the Vald cluster. + +Services that returns status are all services. +If you get it, please verify the state of Vald cluster. + +## UNAVAILABLE + +`UNAVAILABLE` means the gRPC message cannot reach to the Vald cluster. + +You need to verify whether the Vald cluster is running and host and port is correct. diff --git a/docs/api/update.md b/docs/api/update.md index 5c94d180e12..962047d4c05 100644 --- a/docs/api/update.md +++ b/docs/api/update.md @@ -45,23 +45,26 @@ Update RPC is the method to update a single vector. ``` - Update.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|Object.Vector| | \* | the information of vector | - |config|Config| | \* | the configuration of the update request | + + | field | type | label | required | desc. | + | :----: | :------------ | :---- | :------: | :-------------------------------------- | + | vector | Object.Vector | | \* | the information of vector | + | config | Config | | \* | the configuration of the update request | - Update.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | - |filters|Filter.Config| | | configuration for filter | + + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | - Object.Vector - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | ### Output @@ -78,11 +81,12 @@ Update RPC is the method to update a single vector. ``` - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is updated. | - |uuid|string| | the ID of the updated vector. It is the same as an `Object.Vector`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is updated. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :-------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is updated. | + | uuid | string | | the ID of the updated vector. It is the same as an `Object.Vector`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is updated. | ### Status Code @@ -90,6 +94,7 @@ Update RPC is the method to update a single vector. | :--: | :--------------- | | 0 | OK | | 3 | INVALID_ARGUMENT | +| 5 | NOT_FOUND | | 6 | ALREADY_EXISTS | | 13 | INTERNAL | @@ -126,23 +131,26 @@ It's the recommended method to update the large amount of vectors. ``` - Update.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|Object.Vector| | \* | the information of vector | - |config|Config| | \* | the configuration of the update request | + + | field | type | label | required | desc. | + | :----: | :------------ | :---- | :------: | :-------------------------------------- | + | vector | Object.Vector | | \* | the information of vector | + | config | Config | | \* | the configuration of the update request | - Update.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | - |filters|Filter.Config| | | configuration for filter | + + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | - Object.Vector - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of the vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :--------------------------------------------------------------- | + | id | string | | \* | the ID of the vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | ### Output @@ -166,24 +174,27 @@ It's the recommended method to update the large amount of vectors. ``` - Object.StreamLocation - |field|type|label|desc.| - |:---:|:---|:---|:---| - |location|Object.Location| | the information of Object.Location data. | - |status|google.rpc.Status| | the status of google RPC. | + + | field | type | label | desc. | + | :------: | :---------------- | :---- | :--------------------------------------- | + | location | Object.Location | | the information of Object.Location data. | + | status | google.rpc.Status | | the status of google RPC. | - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is updated. | - |uuid|string| | the ID of the exists vector. It is the same as an `Object.Vector`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is inserted. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :--------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is updated. | + | uuid | string | | the ID of the exists vector. It is the same as an `Object.Vector`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is inserted. | - [google.rpc.Status](https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto) - |field|type|label|desc.| - |:---:|:---|:---|:---| - |code|int32| | status code (code list is next section)| - |message|string| | error message | - |details|google.protobuf.Any| repeated(Array[any]) | the details error message list| + + | field | type | label | desc. | + | :-----: | :------------------ | :------------------- | :-------------------------------------- | + | code | int32 | | status code (code list is next section) | + | message | string | | error message | + | details | google.protobuf.Any | repeated(Array[any]) | the details error message list | ### Status Code @@ -191,6 +202,7 @@ It's the recommended method to update the large amount of vectors. | :--: | :--------------- | | 0 | OK | | 3 | INVALID_ARGUMENT | +| 5 | NOT_FOUND | | 6 | ALREADY_EXISTS | | 13 | INTERNAL | @@ -232,28 +244,32 @@ Please be careful that the size of the request exceed the limit. ``` - Update.MultiRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |requests|Insert.Request| repeated(Array[Insert.Request]) | \* | the request list | + + | field | type | label | required | desc. | + | :------: | :------------- | :------------------------------ | :------: | :--------------- | + | requests | Insert.Request | repeated(Array[Insert.Request]) | \* | the request list | - Update.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|Object.Vector| | \* | the information of vector | - |config|Config| | \* | the configuration of the update request | + + | field | type | label | required | desc. | + | :----: | :------------ | :---- | :------: | :-------------------------------------- | + | vector | Object.Vector | | \* | the information of vector | + | config | Config | | \* | the configuration of the update request | - Update.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | - |filters|Filter.Config| | | configuration for filter | + + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | - Object.Vector - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | ### Output @@ -272,16 +288,18 @@ Please be careful that the size of the request exceed the limit. ``` - Object.Locations - |field|type|label|desc.| - |:---:|:---|:---|:---| - |location|Object.Location| repeated(Array[Object.Location]) | the list of `Object.Location`. | + + | field | type | label | desc. | + | :------: | :-------------- | :------------------------------- | :----------------------------- | + | location | Object.Location | repeated(Array[Object.Location]) | the list of `Object.Location`. | - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is updated. | - |uuid|string| | the ID of the updated vector. It is the same as an `Object.Vector`. | - |ips|string| repeated(Array[string]) | the ip list of `vald-agent` pods where the request vector is updated. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :-------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is updated. | + | uuid | string | | the ID of the updated vector. It is the same as an `Object.Vector`. | + | ips | string | repeated(Array[string]) | the ip list of `vald-agent` pods where the request vector is updated. | ### Status Code @@ -289,5 +307,6 @@ Please be careful that the size of the request exceed the limit. | :--: | :--------------- | | 0 | OK | | 3 | INVALID_ARGUMENT | +| 5 | NOT_FOUND | | 6 | ALREADY_EXISTS | | 13 | INTERNAL | diff --git a/docs/api/upsert.md b/docs/api/upsert.md index 4941574a12c..17f19f69af9 100644 --- a/docs/api/upsert.md +++ b/docs/api/upsert.md @@ -49,23 +49,26 @@ Upsert RPC is the method to update a single vector and add a new single vector. ``` - Upsert.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|Object.Vector| | \* | the information of vector | - |config|Config| | \* | the configuration of the upsert request | + + | field | type | label | required | desc. | + | :----: | :------------ | :---- | :------: | :-------------------------------------- | + | vector | Object.Vector | | \* | the information of vector | + | config | Config | | \* | the configuration of the upsert request | - Upsert.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector updated/inserted.
if it is N/A, the current time will be used. | - |filters|Filter.Config| | | configuration for filter | + + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated/inserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | - Object.Vector - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | ### Output @@ -82,11 +85,12 @@ Upsert RPC is the method to update a single vector and add a new single vector. ``` - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is updated/inserted. | - |uuid|string| | the ID of the updated/inserted vector. It is the same as an `Object.Vector`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is updated/inserted. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :----------------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is updated/inserted. | + | uuid | string | | the ID of the updated/inserted vector. It is the same as an `Object.Vector`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is updated/inserted. | ### Status Code @@ -130,23 +134,26 @@ It's the recommended method to upsert the large amount of vectors. ``` - Upsert.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|Object.Vector| | \* | the information of vector | - |config|Config| | \* | the configuration of the upsert request | + + | field | type | label | required | desc. | + | :----: | :------------ | :---- | :------: | :-------------------------------------- | + | vector | Object.Vector | | \* | the information of vector | + | config | Config | | \* | the configuration of the upsert request | - Upsert.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector updated/inserted.
if it is N/A, the current time will be used. | - |filters|Filter.Config| | | configuration for filter | + + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated/inserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | - Object.Vector - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of the vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :--------------------------------------------------------------- | + | id | string | | \* | the ID of the vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | ### Output @@ -170,24 +177,27 @@ It's the recommended method to upsert the large amount of vectors. ``` - Object.StreamLocation - |field|type|label|desc.| - |:---:|:---|:---|:---| - |location|Object.Location| | the information of Object.Location data. | - |status|google.rpc.Status| | the status of google RPC. | + + | field | type | label | desc. | + | :------: | :---------------- | :---- | :--------------------------------------- | + | location | Object.Location | | the information of Object.Location data. | + | status | google.rpc.Status | | the status of google RPC. | - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is updated/inserted. | - |uuid|string| | the ID of the updated/inserted vector. It is the same as an `Object.Vector`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is updated/inserted. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :----------------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is updated/inserted. | + | uuid | string | | the ID of the updated/inserted vector. It is the same as an `Object.Vector`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is updated/inserted. | - [google.rpc.Status](https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto) - |field|type|label|desc.| - |:---:|:---|:---|:---| - |code|int32| | status code (code list is next section)| - |message|string| | error message | - |details|google.protobuf.Any| repeated(Array[any]) | the details error message list| + + | field | type | label | desc. | + | :-----: | :------------------ | :------------------- | :-------------------------------------- | + | code | int32 | | status code (code list is next section) | + | message | string | | error message | + | details | google.protobuf.Any | repeated(Array[any]) | the details error message list | ### Status Code @@ -236,28 +246,32 @@ Please be careful that the size of the request exceed the limit. ``` - Upsert.MultiRequest - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |requests|Upsert.Request| repeated(Array[Insert.Request]) | \* | the request list | + + | field | type | label | required | desc. | + | :------: | :------------- | :------------------------------ | :------: | :--------------- | + | requests | Upsert.Request | repeated(Array[Insert.Request]) | \* | the request list | - Upsert.Request - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |vector|Object.Vector| | \* | the information of vector | - |config|Config| | \* | the configuration of the upsert request | + + | field | type | label | required | desc. | + | :----: | :------------ | :---- | :------: | :-------------------------------------- | + | vector | Object.Vector | | \* | the information of vector | + | config | Config | | \* | the configuration of the upsert request | - Upsert.Config - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |skip_strict_exist_check|bool| | | check the same vector is already updated/inserted or not.
the ID should be unique if the value is `true`. | - |timestamp|int64| | | the timestamp of the vector updated/inserted.
if it is N/A, the current time will be used. | - |filters|Filter.Config| | | configuration for filter | + + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :----------------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already updated/inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated/inserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | - Object.Vector - |field|type|label|required|desc.| - |:---:|:---|:---|:---:|:---| - |id|string| | \* | the ID of a vector. ID should consist of 1 or more characters. | - |vector|float| repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536.| + + | field | type | label | required | desc. | + | :----: | :----- | :--------------------- | :------: | :------------------------------------------------------------- | + | id | string | | \* | the ID of a vector. ID should consist of 1 or more characters. | + | vector | float | repeated(Array[float]) | \* | the vector data. its dimension is between 2 and 65,536. | ### Output @@ -276,16 +290,18 @@ Please be careful that the size of the request exceed the limit. ``` - Object.Locations - |field|type|label|desc.| - |:---:|:---|:---|:---| - |location|Object.Location| repeated(Array[Object.Location]) | the list of `Object.Location` | + + | field | type | label | desc. | + | :------: | :-------------- | :------------------------------- | :---------------------------- | + | location | Object.Location | repeated(Array[Object.Location]) | the list of `Object.Location` | - Object.Location - |field|type|label|desc.| - |:---:|:---|:---|:---| - |name|string| | the name of vald agent pod where the request vector is updated/inserted. | - |uuid|string| | the ID of the updated/inserted vector. It is the same as an `Object.Vector`. | - |ips|string| repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is updated/inserted. | + + | field | type | label | desc. | + | :---: | :----- | :---------------------- | :----------------------------------------------------------------------------- | + | name | string | | the name of vald agent pod where the request vector is updated/inserted. | + | uuid | string | | the ID of the updated/inserted vector. It is the same as an `Object.Vector`. | + | ips | string | repeated(Array[string]) | the IP list of `vald-agent` pods where the request vector is updated/inserted. | ### Status Code