Project: Vald (App Definition and Development / Database)
File: search.md

Search Service is responsible for searching vectors similar to the user request vector from `vald-agent`. ```rpc service Search { rpc Search(payload.v1.Search.Request) returns (payload.v1.Search.Response) {} rpc SearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response) {} rpc StreamSearch(stream payload.v1.Search.Request) returns (stream payload.v1.Search.StreamResponse) {} rpc StreamSearchByID(stream payload.v1.Search.IDRequest) returns (stream payload.v1.Search.StreamResponse) {} rpc MultiSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses) {} rpc MultiSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses) {} rpc LinearSearch(payload.v1.Search.Request) returns (payload.v1.Search.Response) {} rpc LinearSearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response) {} rpc StreamLinearSearch(stream payload.v1.Search.Request) returns (stream payload.v1.Search.StreamResponse) {} rpc StreamLinearSearchByID(stream payload.v1.Search.IDRequest) returns (stream payload.v1.Search.StreamResponse) {} rpc MultiLinearSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses) {} rpc MultiLinearSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses) {} } ``` Search RPC is the method to search vector(s) similar to the request vector. the scheme of `payload.v1.Search.Request` ```rpc message Search { message Request { repeated float vector = 1 [ (validate.rules).repeated .min_items = 2 ]; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; float radius = 3; float epsilon = 4; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.Request | field | type | label | required | description | | :-: | :-- | : | :: | : | | 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 | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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 results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.Response`. ```rpc message Search { message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0

Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :-- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, or some request payload is invalid. | Check Agent config, request payload, and fix request payload or Agent config. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | SearchByID RPC is the method to search similar vectors using a user-defined vector ID.<br> The vector with the same requested ID should be indexed into the `vald-agent` before searching. the scheme of `payload.v1.Search.IDRequest` ```rpc message Search { message IDRequest { string id = 1; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; float radius = 3; float epsilon = 4; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.IDRequest | field | type | label | required | description | | :-: | :-- | :- | :: | : | | id | string | | \* | The vector ID to be searched. | | config | Config | | \* | The configuration of the search request. | Search.Config | field | type | label | required | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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 results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.Response`. ```rpc message Search { message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. |

| field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Requested vector's ID is empty, or some request payload is invalid. | Check request payload and fix request payload. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | StreamSearch RPC is the method to search vectors with multi queries(vectors) using the .<br> Using the bidirectional streaming RPC, the search request can be communicated in any order between the client and server. Each Search request and response are independent. the scheme of `payload.v1.Search.Request stream` ```rpc message Search { message Request { repeated float vector = 1 [ (validate.rules).repeated .min_items = 2 ]; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; float radius = 3; float epsilon = 4; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.Request | field | type | label | required | description | | :-: | :-- | : | :: | : | | 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 | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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

| | min_num | uint32 | | | The minimum number of results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.StreamResponse`. ```rpc message Search { message StreamResponse { oneof payload { Response response = 1; google.rpc.Status status = 2; } } message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.StreamResponse | field | type | label | description | | :: | :- | :- | :-- | | response | Response | | The search result response. | | status | google.rpc.Status | | The status of Google RPC. | Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :-- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, or some request payload is invalid. | Check Agent config, request payload, and fix request payload or Agent config. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | StreamSearchByID RPC is the method to search vectors with multi queries(IDs) using the .<br> Using the bidirectional streaming RPC, the search request can be communicated in any order between the client and server. Each SearchByID request and response are independent. the scheme of `payload.v1.Search.IDRequest stream` ```rpc message Search { message IDRequest { string id = 1; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; float radius = 3; float epsilon = 4; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ```

| field | type | label | required | description | | :-: | :-- | :- | :: | : | | id | string | | \* | The vector ID to be searched. | | config | Config | | \* | The configuration of the search request. | Search.Config | field | type | label | required | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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 results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.StreamResponse`. ```rpc message Search { message StreamResponse { oneof payload { Response response = 1; google.rpc.Status status = 2; } } message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.StreamResponse | field | type | label | description | | :: | :- | :- | :-- | | response | Response | | The search result response. | | status | google.rpc.Status | | The status of Google RPC. | Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Requested vector's ID is empty, or some request payload is invalid. | Check request payload and fix request payload. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result

| Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | MultiSearch RPC is the method to search vectors with multiple vectors in 1 request. <div class="notice"> gRPC has a message size limitation.<br> Please be careful that the size of the request exceeds the limit. </div> the scheme of `payload.v1.Search.MultiRequest` ```rpc message Search { message MultiRequest { repeated Request requests = 1; } message Request { repeated float vector = 1 [ (validate.rules).repeated .min_items = 2 ]; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; float radius = 3; float epsilon = 4; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.MultiRequest | field | type | label | required | description | | :: | :-- | :- | :: | :-- | | requests | repeated(Array[Request]) | | \* | The search request list. | Search.Request | field | type | label | required | description | | :-: | :-- | : | :: | : | | 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 | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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 results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.Responses`. ```rpc message Search { message Responses { repeated Response responses = 1; } message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.Responses | field | type | label | description | | :-: | :- | : | :-- | | responses | Response | repeated(Array[Response]) | The list of search results response. | Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request

| | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :-- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, or some request payload is invalid. | Check Agent config, request payload, and fix request payload or Agent config. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | MultiSearchByID RPC is the method to search vectors with multiple IDs in 1 request. <div class="notice"> gRPC has a message size limitation.<br> Please be careful that the size of the request exceeds the limit. </div> the scheme of `payload.v1.Search.MultiIDRequest stream` ```rpc message Search { message MultiIDRequest { repeated IDRequest requests = 1; } message IDRequest { string id = 1; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; float radius = 3; float epsilon = 4; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.MultiIDRequest | field | type | label | required | description | | :: | :-- | :- | :: | : | | requests | IDRequest | repeated(Array[IDRequest]) | \* | The searchByID request list. | Search.IDRequest | field | type | label | required | description | | :-: | :-- | :- | :: | : | | id | string | | \* | The vector ID to be searched. | | config | Config | | \* | The configuration of the search request. | Search.Config | field | type | label | required | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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

| | min_num | uint32 | | | The minimum number of results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.Responses`. ```rpc message Search { message Responses { repeated Response responses = 1; } message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.Responses | field | type | label | description | | :-: | :- | : | :-- | | responses | Response | repeated(Array[Response]) | The list of search results response. | Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Requested vector's ID is empty, or some request payload is invalid. | Check request payload and fix request payload. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | LinearSearch RPC is the method to linear search vector(s) similar to the request vector. the scheme of `payload.v1.Search.Request` ```rpc message Search { message Request { repeated float vector = 1 [ (validate.rules).repeated .min_items = 2 ]; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.Request | field | type | label | required | description | | :-: | :-- | : | :: | : | | vector | float | repeated(Array[float]) | \* | The vector data. Its dimension is between 2 and

| | config | Config | | \* | The configuration of the search request. | Search.Config | field | type | label | required | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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 results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.Response`. ```rpc message Search { message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :-- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, or some request payload is invalid. | Check Agent config, request payload, and fix request payload or Agent config. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | LinearSearchByID RPC is the method to linear search similar vectors using a user-defined vector ID.<br> The vector with the same requested ID should be indexed into the `vald-agent` before searching. You will get a `NOT_FOUND` error if the vector isn't stored. the scheme of `payload.v1.Search.IDRequest` ```rpc message Search { message IDRequest { string id = 1; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; int64 timeout = 5; Filter.Config ingress_filters = 6;

egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.IDRequest | field | type | label | required | description | | :-: | :-- | :- | :: | : | | id | string | | \* | The vector ID to be searched. | | config | Config | | \* | The configuration of the search request. | Search.Config | field | type | label | required | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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 results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.Response`. ```rpc message Search { message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Requested vector's ID is empty, or some request payload is invalid. | Check request payload and fix request payload. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | StreamLinearSearch RPC is the method to linear search vectors with multi queries(vectors) using the

Using the bidirectional streaming RPC, the linear search request can be communicated in any order between the client and server. Each LinearSearch request and response are independent. the scheme of `payload.v1.Search.Request stream` ```rpc message Search { message Request { repeated float vector = 1 [ (validate.rules).repeated .min_items = 2 ]; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.Request | field | type | label | required | description | | :-: | :-- | : | :: | : | | 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 | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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 results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.StreamResponse`. ```rpc message Search { message StreamResponse { oneof payload { Response response = 1; google.rpc.Status status = 2; } } message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.StreamResponse | field | type | label | description | | :: | :- | :- | :-- | | response | Response | | The search result response. | | status | google.rpc.Status | | The status of Google RPC. | Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :-- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and

| Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, or some request payload is invalid. | Check Agent config, request payload, and fix request payload or Agent config. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | StreamLinearSearchByID RPC is the method to linear search vectors with multi queries(IDs) using the .<br> Using the bidirectional streaming RPC, the linear search request can be communicated in any order between the client and server. Each LinearSearchByID request and response are independent. the scheme of `payload.v1.Search.IDRequest stream` ```rpc message Search { message IDRequest { string id = 1; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.IDRequest | field | type | label | required | description | | :-: | :-- | :- | :: | : | | id | string | | \* | The vector ID to be searched. | | config | Config | | \* | The configuration of the search request. | Search.Config | field | type | label | required | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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 results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.StreamResponse`. ```rpc message Search { message StreamResponse { oneof payload { Response response = 1; google.rpc.Status status = 2; } } message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.StreamResponse | field | type | label | description | | :: | :- | :- | :-- | | response | Response | | The search result response. | | status | google.rpc.Status | | The status of Google RPC. | Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector

| | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Requested vector's ID is empty, or some request payload is invalid. | Check request payload and fix request payload. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | MultiLinearSearch RPC is the method to linear search vectors with multiple vectors in 1 request. <div class="notice"> gRPC has a message size limitation.<br> Please be careful that the size of the request exceeds the limit. </div> the scheme of `payload.v1.Search.MultiRequest` ```rpc message Search { message MultiRequest { repeated Request requests = 1; } message Request { repeated float vector = 1 [ (validate.rules).repeated .min_items = 2 ]; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.MultiRequest | field | type | label | required | description | | :: | :-- | :- | :: | :- | | requests | repeated(Array[Request]) | | \* | The search request list | Search.Request | field | type | label | required | description | | :-: | :-- | : | :: | : | | 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 | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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 results to be

| | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.Responses`. ```rpc message Search { message Responses { repeated Response responses = 1; } message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.Responses | field | type | label | description | | :-: | :- | : | :- | | responses | Response | repeated(Array[Response]) | The list of search results response | Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :-- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, or some request payload is invalid. | Check Agent config, request payload, and fix request payload or Agent config. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | MultiLinearSearchByID RPC is the method to linear search vectors with multiple IDs in 1 request. <div class="notice"> gRPC has a message size limitation.<br> Please be careful that the size of the request exceeds the limit. </div> the scheme of `payload.v1.Search.MultiIDRequest stream` ```rpc message Search { message MultiIDRequest { repeated IDRequest requests = 1; } message IDRequest { string id = 1; Config config = 2; } message Config { string request_id = 1; uint32 num = 2 [ (validate.rules).uint32.gte = 1 ]; int64 timeout = 5; Filter.Config ingress_filters = 6; Filter.Config egress_filters = 7; uint32 min_num = 8; AggregationAlgorithm aggregation_algorithm = 9; } } enum AggregationAlgorithm { Unknown = 0; ConcurrentQueue = 1; SortSlice = 2; SortPoolSlice = 3; PairingHeap = 4; } ``` Search.MultiIDRequest | field | type | label | required | description | | :: | :-- | :- | :: | : | | requests | IDRequest | repeated(Array[IDRequest]) | \* | The searchByID request

| Search.IDRequest | field | type | label | required | description | | :-: | :-- | :- | :: | : | | id | string | | \* | The vector ID to be searched. | | config | Config | | \* | The configuration of the search request. | Search.Config | field | type | label | required | description | | :-: | :- | :- | :: | :- | | request_id | string | | | Unique request ID. | | num | uint32 | | \* | The maximum number of results 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 results to be returned. | | aggregation_algorithm | AggregationAlgorithm | | | The search aggregation algorithm option (default value is `ConcurrentQueue`). | the scheme of `payload.v1.Search.Responses`. ```rpc message Search { message Responses { repeated Response responses = 1; } message Response { string request_id = 1; repeated Object.Distance results = 2; } } message Object { message Distance { string id = 1; float distance = 2; } } ``` Search.Responses | field | type | label | description | | :-: | :- | : | :-- | | responses | Response | repeated(Array[Response]) | The list of search results response. | Search.Response | field | type | label | description | | :--: | :-- | :- | : | | request_id | string | | The unique request ID. | | results | Object.Distance | repeated(Array[Object.Distance]) | Search results. | Object.Distance | field | type | label | description | | :: | :-- | :- | :- | | id | string | | The vector ID. | | distance | float | | The distance between the result vector and the request vector. | | code | name | | :--: | :- | | 0 | OK | | 1 | CANCELLED | | 3 | INVALID_ARGUMENT | | 4 | DEADLINE_EXCEEDED | | 5 | NOT_FOUND | | 10 | ABORTED | | 13 | INTERNAL | Please refer to for more details. The request process may not be completed when the response code is NOT `0 (OK)`. Here are some common reasons and how to resolve each error. | name | common reason | how to resolve | | :- | :- | : | | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. | | INVALID_ARGUMENT | The Requested vector's ID is empty, or some request payload is invalid. | Check request payload and fix request payload. | | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | | NOTFOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set minnum to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. |