diff --git a/apis/proto/v1/vald/filter.proto b/apis/proto/v1/vald/filter.proto index d3502fe399..447813cd28 100644 --- a/apis/proto/v1/vald/filter.proto +++ b/apis/proto/v1/vald/filter.proto @@ -28,7 +28,7 @@ option java_package = "org.vdaas.vald.api.v1.vald"; // Overview // Filter Server is responsible for providing insert, update, upsert and search interface for `Vald Filter Gateway`. -// +// // Vald Filter Gateway forward user request to user-defined ingress/egress filter components allowing user to run custom logic. service Filter { // Overview @@ -69,7 +69,7 @@ service Filter { // Overview // MultiSearchObject RPC is the method to search objects with multiple objects in **1** request. - // + // //
// gRPC has a message size limitation.
// Please be careful that the size of the request exceeds the limit. @@ -103,7 +103,7 @@ service Filter { // Overview // StreamInsertObject RPC is the method to add new multiple object using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc). - // + // // By using the bidirectional streaming RPC, the insert request can be communicated in any order between client and server. // Each Insert request and response are independent. // It's the recommended method to insert a large number of objects. @@ -168,14 +168,14 @@ service Filter { // Overview // MultiUpdateObject is the method to update multiple objects in **1** request. - // + // //
// gRPC has the message size limitation.
// Please be careful that the size of the request exceed the limit. //
// --- // Status Code - // + // // | 0 | OK | // | 1 | CANCELLED | // | 3 | INVALID_ARGUMENT | @@ -220,7 +220,7 @@ service Filter { // Overview // MultiUpsertObject is the method to update existing multiple objects and add new multiple objects in **1** request. - // + // //
// gRPC has a message size limitation.
// Please be careful that the size of the request exceeds the limit. diff --git a/apis/proto/v1/vald/index.proto b/apis/proto/v1/vald/index.proto index ae7eb1a145..50bf7e2ff9 100644 --- a/apis/proto/v1/vald/index.proto +++ b/apis/proto/v1/vald/index.proto @@ -34,13 +34,13 @@ service Index { rpc IndexInfo(payload.v1.Empty) returns (payload.v1.Info.Index.Count) { option (google.api.http).get = "/index/info"; } - + // Overview // Represent the RPC to get the index information for each agents. rpc IndexDetail(payload.v1.Empty) returns (payload.v1.Info.Index.Detail) { option (google.api.http).get = "/index/detail"; } - + // Overview // Represent the RPC to get the index statistics. rpc IndexStatistics(payload.v1.Empty) returns (payload.v1.Info.Index.Statistics) { diff --git a/apis/proto/v1/vald/insert.proto b/apis/proto/v1/vald/insert.proto index 80e4e86512..27df53c546 100644 --- a/apis/proto/v1/vald/insert.proto +++ b/apis/proto/v1/vald/insert.proto @@ -44,7 +44,7 @@ service Insert { // 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. | @@ -76,9 +76,9 @@ service Insert { // --- // Troubleshooting // 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. | @@ -90,7 +90,7 @@ service Insert { // Overview // MultiInsert RPC is the method to add multiple new vectors in **1** request. - // + // //
// gRPC has a message size limitation.
// Please be careful that the size of the request exceeds the limit. @@ -107,9 +107,9 @@ service Insert { // --- // Troubleshooting // 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. | diff --git a/apis/proto/v1/vald/object.proto b/apis/proto/v1/vald/object.proto index 7805c5eb7d..620447c25f 100644 --- a/apis/proto/v1/vald/object.proto +++ b/apis/proto/v1/vald/object.proto @@ -42,9 +42,9 @@ service Object { // --- // Troubleshooting // 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. | @@ -69,9 +69,9 @@ service Object { // --- // Troubleshooting // 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. | @@ -98,9 +98,9 @@ service Object { // --- // Troubleshooting // 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. | diff --git a/apis/proto/v1/vald/remove.proto b/apis/proto/v1/vald/remove.proto index a2bbf6eace..2f4b0506d2 100644 --- a/apis/proto/v1/vald/remove.proto +++ b/apis/proto/v1/vald/remove.proto @@ -43,9 +43,9 @@ service Remove { // --- // Troubleshooting // 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. | @@ -62,7 +62,7 @@ service Remove { // Overview // RemoveByTimestamp RPC is the method to remove vectors based on timestamp. - // + // //
// In the TimestampRequest message, the 'timestamps' field is repeated, allowing the inclusion of multiple Timestamp.
// When multiple Timestamps are provided, it results in an `AND` condition, enabling the realization of deletions with specified ranges.
@@ -78,15 +78,15 @@ service Remove { // --- // Troubleshooting // 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. | // | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. | // | NOT_FOUND | No vectors in the system match the specified timestamp conditions. | Check whether vectors matching the specified timestamp conditions exist in the system, and fix conditions if needed. | - // | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. + // | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. rpc RemoveByTimestamp(payload.v1.Remove.TimestampRequest) returns (payload.v1.Object.Locations) { option (google.api.http) = { post: "/remove/timestamp" @@ -96,7 +96,7 @@ service Remove { // Overview // A method to remove multiple indexed vectors by bidirectional streaming. - // + // // StreamRemove RPC is the method to remove multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
// Using the bidirectional streaming RPC, the remove request can be communicated in any order between client and server. // Each Remove request and response are independent. @@ -113,9 +113,9 @@ service Remove { // --- // Troubleshooting // 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. | @@ -127,7 +127,7 @@ service Remove { // Overview // MultiRemove is the method to remove multiple vectors in **1** request. - // + // //
// gRPC has a message size limitation.
// Please be careful that the size of the request exceeds the limit. @@ -144,9 +144,9 @@ service Remove { // --- // Troubleshooting // 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. | diff --git a/apis/proto/v1/vald/search.proto b/apis/proto/v1/vald/search.proto index ef1b276619..d49ca1c0b9 100644 --- a/apis/proto/v1/vald/search.proto +++ b/apis/proto/v1/vald/search.proto @@ -43,9 +43,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -75,9 +75,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -108,9 +108,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -136,9 +136,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -150,7 +150,7 @@ service Search { // Overview // MultiSearch RPC is the method to search vectors with multiple vectors in **1** request. - // + // //
// gRPC has a message size limitation.
// Please be careful that the size of the request exceeds the limit. @@ -167,9 +167,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -186,7 +186,7 @@ service Search { // Overview // MultiSearchByID RPC is the method to search vectors with multiple IDs in **1** request. - // + // //
// gRPC has a message size limitation.
// Please be careful that the size of the request exceeds the limit. @@ -203,9 +203,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -234,9 +234,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -267,9 +267,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -300,9 +300,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -328,9 +328,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -342,7 +342,7 @@ service Search { // Overview // MultiLinearSearch RPC is the method to linear search vectors with multiple vectors in **1** request. - // + // //
// gRPC has a message size limitation.
// Please be careful that the size of the request exceeds the limit. @@ -359,9 +359,9 @@ service Search { // --- // Troubleshooting // 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. | @@ -378,7 +378,7 @@ service Search { // Overview // MultiLinearSearchByID RPC is the method to linear search vectors with multiple IDs in **1** request. - // + // //
// gRPC has a message size limitation.
// Please be careful that the size of the request exceeds the limit. @@ -395,9 +395,9 @@ service Search { // --- // Troubleshooting // 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. | diff --git a/apis/proto/v1/vald/update.proto b/apis/proto/v1/vald/update.proto index f67b57b215..1cb5983cd8 100644 --- a/apis/proto/v1/vald/update.proto +++ b/apis/proto/v1/vald/update.proto @@ -44,9 +44,9 @@ service Update { // --- // Troubleshooting // 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. | @@ -80,9 +80,9 @@ service Update { // --- // Troubleshooting // 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. | @@ -95,7 +95,7 @@ service Update { // Overview // MultiUpdate is the method to update multiple vectors in **1** request. - // + // //
// gRPC has a message size limitation.
// Please be careful that the size of the request exceeds the limit. @@ -113,9 +113,9 @@ service Update { // --- // Troubleshooting // 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. | diff --git a/apis/proto/v1/vald/upsert.proto b/apis/proto/v1/vald/upsert.proto index 0038277d51..4fa53046ed 100644 --- a/apis/proto/v1/vald/upsert.proto +++ b/apis/proto/v1/vald/upsert.proto @@ -44,9 +44,9 @@ service Upsert { // --- // Troubleshooting // 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. | @@ -79,9 +79,9 @@ service Upsert { // --- // Troubleshooting // 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. | @@ -93,7 +93,7 @@ service Upsert { // Overview // MultiUpsert is the method to update existing multiple vectors and add new multiple vectors in **1** request. - // + // //
// gRPC has a message size limitation.
// Please be careful that the size of the request exceeds the limit. @@ -111,9 +111,9 @@ service Upsert { // --- // Troubleshooting // 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. |