diff --git a/Makefile b/Makefile index 939adae..ba6f710 100755 --- a/Makefile +++ b/Makefile @@ -44,6 +44,7 @@ TEST_DATASET_PATH = tests/wordvecs1000.json PROTOS = \ v1/agent/core/agent.proto \ v1/vald/filter.proto \ + v1/vald/flush.proto \ v1/vald/insert.proto \ v1/vald/object.proto \ v1/vald/index.proto \ diff --git a/src/google/protobuf/descriptor_pb.d.ts b/src/google/protobuf/descriptor_pb.d.ts index 236c273..cd7bfbe 100644 --- a/src/google/protobuf/descriptor_pb.d.ts +++ b/src/google/protobuf/descriptor_pb.d.ts @@ -1001,13 +1001,12 @@ export interface MessageOptions { */ export interface FieldOptions { /** - * NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead. * The ctype option instructs the C++ code generator to use a different * representation of the field than it normally would. See the specific * options below. This option is only implemented to support use of * [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of - * type "bytes" in the open source release. - * TODO: make ctype actually deprecated. + * type "bytes" in the open source release -- sorry, we'll try to include + * other types in a future version! * * @generated from protobuf field: optional google.protobuf.FieldOptions.CType ctype = 1; */ @@ -1227,6 +1226,8 @@ export declare enum FieldOptions_JSType { } /** * If set to RETENTION_SOURCE, the option will be omitted from the binary. + * Note: as of January 2023, support for this is in progress and does not yet + * have an effect (b/264593489). * * @generated from protobuf enum google.protobuf.FieldOptions.OptionRetention */ @@ -1247,7 +1248,8 @@ export declare enum FieldOptions_OptionRetention { /** * This indicates the types of entities that the field may apply to when used * as an option. If it is unset, then the field may be freely used as an - * option on any kind of entity. + * option on any kind of entity. Note: as of January 2023, support for this is + * in progress and does not yet have an effect (b/264593489). * * @generated from protobuf enum google.protobuf.FieldOptions.OptionTargetType */ @@ -2018,7 +2020,7 @@ export declare enum Edition { EDITION_2024 = 1001, /** * Placeholder editions for testing feature resolution. These should not be - * used or relied on outside of tests. + * used or relyed on outside of tests. * * @generated from protobuf enum value: EDITION_1_TEST_ONLY = 1; */ diff --git a/src/google/protobuf/descriptor_pb.js b/src/google/protobuf/descriptor_pb.js index f412434..fdd2341 100644 --- a/src/google/protobuf/descriptor_pb.js +++ b/src/google/protobuf/descriptor_pb.js @@ -286,6 +286,8 @@ var FieldOptions_JSType; })(FieldOptions_JSType = exports.FieldOptions_JSType || (exports.FieldOptions_JSType = {})); /** * If set to RETENTION_SOURCE, the option will be omitted from the binary. + * Note: as of January 2023, support for this is in progress and does not yet + * have an effect (b/264593489). * * @generated from protobuf enum google.protobuf.FieldOptions.OptionRetention */ @@ -307,7 +309,8 @@ var FieldOptions_OptionRetention; /** * This indicates the types of entities that the field may apply to when used * as an option. If it is unset, then the field may be freely used as an - * option on any kind of entity. + * option on any kind of entity. Note: as of January 2023, support for this is + * in progress and does not yet have an effect (b/264593489). * * @generated from protobuf enum google.protobuf.FieldOptions.OptionTargetType */ @@ -566,7 +569,7 @@ var Edition; Edition[Edition["EDITION_2024"] = 1001] = "EDITION_2024"; /** * Placeholder editions for testing feature resolution. These should not be - * used or relied on outside of tests. + * used or relyed on outside of tests. * * @generated from protobuf enum value: EDITION_1_TEST_ONLY = 1; */ diff --git a/src/vald/v1/vald/filter_pb.grpc-client.d.ts b/src/vald/v1/vald/filter_pb.grpc-client.d.ts index 4c41d16..8f13279 100644 --- a/src/vald/v1/vald/filter_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/filter_pb.grpc-client.d.ts @@ -38,25 +38,13 @@ import type { Search_Response } from "../payload/payload_pb"; import type { Search_ObjectRequest } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * 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. + * Filter service provides ways to connect to Vald through filter. * * @generated from protobuf service vald.v1.Filter */ export interface IFilterClient { /** - * Overview - * SearchObject RPC is the method to search object(s) similar to request object. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to search object. * * @generated from protobuf rpc: SearchObject(payload.v1.Search.ObjectRequest) returns (payload.v1.Search.Response); */ @@ -65,18 +53,7 @@ export interface IFilterClient { searchObject(input: Search_ObjectRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Search_Response) => void): grpc.ClientUnaryCall; searchObject(input: Search_ObjectRequest, callback: (err: grpc.ServiceError | null, value?: Search_Response) => void): grpc.ClientUnaryCall; /** - * Overview - * StreamSearchObject RPC is the method to search vectors with multi queries(objects) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * By using the bidirectional streaming RPC, the search request can be communicated in any order between client and server. - * Each Search request and response are independent. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to search multiple objects. * * @generated from protobuf rpc: MultiSearchObject(payload.v1.Search.MultiObjectRequest) returns (payload.v1.Search.Responses); */ @@ -85,37 +62,14 @@ export interface IFilterClient { multiSearchObject(input: Search_MultiObjectRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Search_Responses) => void): grpc.ClientUnaryCall; multiSearchObject(input: Search_MultiObjectRequest, callback: (err: grpc.ServiceError | null, value?: Search_Responses) => void): grpc.ClientUnaryCall; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to search object by bidirectional streaming. * * @generated from protobuf rpc: StreamSearchObject(stream payload.v1.Search.ObjectRequest) returns (stream payload.v1.Search.StreamResponse); */ streamSearchObject(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamSearchObject(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * Overview - * InsertObject RPC is the method to insert object through Vald Filter Gateway. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method insert object. * * @generated from protobuf rpc: InsertObject(payload.v1.Insert.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -124,36 +78,14 @@ export interface IFilterClient { insertObject(input: Insert_ObjectRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; insertObject(input: Insert_ObjectRequest, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; /** - * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * Represent the streaming RPC to insert object by bidirectional streaming. * * @generated from protobuf rpc: StreamInsertObject(stream payload.v1.Insert.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ streamInsertObject(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamInsertObject(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * Overview - * MultiInsertObject RPC is the method to add multiple new objects in **1** request. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to insert multiple objects. * * @generated from protobuf rpc: MultiInsertObject(payload.v1.Insert.MultiObjectRequest) returns (payload.v1.Object.Locations); */ @@ -162,16 +94,7 @@ export interface IFilterClient { multiInsertObject(input: Insert_MultiObjectRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; multiInsertObject(input: Insert_MultiObjectRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; /** - * Overview - * UpdateObject RPC is the method to update a single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to update object. * * @generated from protobuf rpc: UpdateObject(payload.v1.Update.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -180,41 +103,14 @@ export interface IFilterClient { updateObject(input: Update_ObjectRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; updateObject(input: Update_ObjectRequest, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; /** - * Overview - * StreamUpdateObject RPC is the method to update multiple objects using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * By using the bidirectional streaming RPC, the update request can be communicated in any order between client and server. - * Each Update request and response are independent. - * It's the recommended method to update the large amount of objects. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to update object by bidirectional streaming. * * @generated from protobuf rpc: StreamUpdateObject(stream payload.v1.Update.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ streamUpdateObject(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamUpdateObject(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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 | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to update multiple objects. * * @generated from protobuf rpc: MultiUpdateObject(payload.v1.Update.MultiObjectRequest) returns (payload.v1.Object.Locations); */ @@ -223,16 +119,7 @@ export interface IFilterClient { multiUpdateObject(input: Update_MultiObjectRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; multiUpdateObject(input: Update_MultiObjectRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; /** - * Overview - * UpsertObject RPC is the method to update a single object and add a new single object. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to upsert object. * * @generated from protobuf rpc: UpsertObject(payload.v1.Upsert.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -241,37 +128,14 @@ export interface IFilterClient { upsertObject(input: Upsert_ObjectRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; upsertObject(input: Upsert_ObjectRequest, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; /** - * Overview - * UpsertObject RPC is the method to update a single object and add a new single object. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to upsert object by bidirectional streaming. * * @generated from protobuf rpc: StreamUpsertObject(stream payload.v1.Upsert.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ streamUpsertObject(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamUpsertObject(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to upsert multiple objects. * * @generated from protobuf rpc: MultiUpsertObject(payload.v1.Upsert.MultiObjectRequest) returns (payload.v1.Object.Locations); */ @@ -281,10 +145,7 @@ export interface IFilterClient { multiUpsertObject(input: Upsert_MultiObjectRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; } /** - * 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. + * Filter service provides ways to connect to Vald through filter. * * @generated from protobuf service vald.v1.Filter */ @@ -292,206 +153,73 @@ export declare class FilterClient extends grpc.Client implements IFilterClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * Overview - * SearchObject RPC is the method to search object(s) similar to request object. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to search object. * * @generated from protobuf rpc: SearchObject(payload.v1.Search.ObjectRequest) returns (payload.v1.Search.Response); */ searchObject(input: Search_ObjectRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Response) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Response) => void), callback?: ((err: grpc.ServiceError | null, value?: Search_Response) => void)): grpc.ClientUnaryCall; /** - * Overview - * StreamSearchObject RPC is the method to search vectors with multi queries(objects) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * By using the bidirectional streaming RPC, the search request can be communicated in any order between client and server. - * Each Search request and response are independent. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to search multiple objects. * * @generated from protobuf rpc: MultiSearchObject(payload.v1.Search.MultiObjectRequest) returns (payload.v1.Search.Responses); */ multiSearchObject(input: Search_MultiObjectRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Responses) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Responses) => void), callback?: ((err: grpc.ServiceError | null, value?: Search_Responses) => void)): grpc.ClientUnaryCall; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to search object by bidirectional streaming. * * @generated from protobuf rpc: StreamSearchObject(stream payload.v1.Search.ObjectRequest) returns (stream payload.v1.Search.StreamResponse); */ streamSearchObject(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * Overview - * InsertObject RPC is the method to insert object through Vald Filter Gateway. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method insert object. * * @generated from protobuf rpc: InsertObject(payload.v1.Insert.ObjectRequest) returns (payload.v1.Object.Location); */ insertObject(input: Insert_ObjectRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Location) => void)): grpc.ClientUnaryCall; /** - * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * Represent the streaming RPC to insert object by bidirectional streaming. * * @generated from protobuf rpc: StreamInsertObject(stream payload.v1.Insert.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ streamInsertObject(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * Overview - * MultiInsertObject RPC is the method to add multiple new objects in **1** request. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to insert multiple objects. * * @generated from protobuf rpc: MultiInsertObject(payload.v1.Insert.MultiObjectRequest) returns (payload.v1.Object.Locations); */ multiInsertObject(input: Insert_MultiObjectRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Locations) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Locations) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Locations) => void)): grpc.ClientUnaryCall; /** - * Overview - * UpdateObject RPC is the method to update a single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to update object. * * @generated from protobuf rpc: UpdateObject(payload.v1.Update.ObjectRequest) returns (payload.v1.Object.Location); */ updateObject(input: Update_ObjectRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Location) => void)): grpc.ClientUnaryCall; /** - * Overview - * StreamUpdateObject RPC is the method to update multiple objects using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * By using the bidirectional streaming RPC, the update request can be communicated in any order between client and server. - * Each Update request and response are independent. - * It's the recommended method to update the large amount of objects. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to update object by bidirectional streaming. * * @generated from protobuf rpc: StreamUpdateObject(stream payload.v1.Update.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ streamUpdateObject(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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 | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to update multiple objects. * * @generated from protobuf rpc: MultiUpdateObject(payload.v1.Update.MultiObjectRequest) returns (payload.v1.Object.Locations); */ multiUpdateObject(input: Update_MultiObjectRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Locations) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Locations) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Locations) => void)): grpc.ClientUnaryCall; /** - * Overview - * UpsertObject RPC is the method to update a single object and add a new single object. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to upsert object. * * @generated from protobuf rpc: UpsertObject(payload.v1.Upsert.ObjectRequest) returns (payload.v1.Object.Location); */ upsertObject(input: Upsert_ObjectRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Location) => void)): grpc.ClientUnaryCall; /** - * Overview - * UpsertObject RPC is the method to update a single object and add a new single object. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to upsert object by bidirectional streaming. * * @generated from protobuf rpc: StreamUpsertObject(stream payload.v1.Upsert.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ streamUpsertObject(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to upsert multiple objects. * * @generated from protobuf rpc: MultiUpsertObject(payload.v1.Upsert.MultiObjectRequest) returns (payload.v1.Object.Locations); */ diff --git a/src/vald/v1/vald/filter_pb.grpc-client.js b/src/vald/v1/vald/filter_pb.grpc-client.js index fb27414..8c6e23f 100644 --- a/src/vald/v1/vald/filter_pb.grpc-client.js +++ b/src/vald/v1/vald/filter_pb.grpc-client.js @@ -48,10 +48,7 @@ exports.FilterClient = void 0; const filter_pb_1 = require("./filter_pb"); const grpc = require("@grpc/grpc-js"); /** - * 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. + * Filter service provides ways to connect to Vald through filter. * * @generated from protobuf service vald.v1.Filter */ @@ -61,16 +58,7 @@ class FilterClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * Overview - * SearchObject RPC is the method to search object(s) similar to request object. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to search object. * * @generated from protobuf rpc: SearchObject(payload.v1.Search.ObjectRequest) returns (payload.v1.Search.Response); */ @@ -79,18 +67,7 @@ class FilterClient extends grpc.Client { return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * StreamSearchObject RPC is the method to search vectors with multi queries(objects) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * By using the bidirectional streaming RPC, the search request can be communicated in any order between client and server. - * Each Search request and response are independent. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to search multiple objects. * * @generated from protobuf rpc: MultiSearchObject(payload.v1.Search.MultiObjectRequest) returns (payload.v1.Search.Responses); */ @@ -99,21 +76,7 @@ class FilterClient extends grpc.Client { return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to search object by bidirectional streaming. * * @generated from protobuf rpc: StreamSearchObject(stream payload.v1.Search.ObjectRequest) returns (stream payload.v1.Search.StreamResponse); */ @@ -122,16 +85,7 @@ class FilterClient extends grpc.Client { return this.makeBidiStreamRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * Overview - * InsertObject RPC is the method to insert object through Vald Filter Gateway. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method insert object. * * @generated from protobuf rpc: InsertObject(payload.v1.Insert.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -140,20 +94,7 @@ class FilterClient extends grpc.Client { return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * Represent the streaming RPC to insert object by bidirectional streaming. * * @generated from protobuf rpc: StreamInsertObject(stream payload.v1.Insert.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ @@ -162,16 +103,7 @@ class FilterClient extends grpc.Client { return this.makeBidiStreamRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * Overview - * MultiInsertObject RPC is the method to add multiple new objects in **1** request. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to insert multiple objects. * * @generated from protobuf rpc: MultiInsertObject(payload.v1.Insert.MultiObjectRequest) returns (payload.v1.Object.Locations); */ @@ -180,16 +112,7 @@ class FilterClient extends grpc.Client { return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * UpdateObject RPC is the method to update a single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to update object. * * @generated from protobuf rpc: UpdateObject(payload.v1.Update.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -198,19 +121,7 @@ class FilterClient extends grpc.Client { return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * StreamUpdateObject RPC is the method to update multiple objects using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * By using the bidirectional streaming RPC, the update request can be communicated in any order between client and server. - * Each Update request and response are independent. - * It's the recommended method to update the large amount of objects. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to update object by bidirectional streaming. * * @generated from protobuf rpc: StreamUpdateObject(stream payload.v1.Update.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ @@ -219,22 +130,7 @@ class FilterClient extends grpc.Client { return this.makeBidiStreamRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * 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 | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to update multiple objects. * * @generated from protobuf rpc: MultiUpdateObject(payload.v1.Update.MultiObjectRequest) returns (payload.v1.Object.Locations); */ @@ -243,16 +139,7 @@ class FilterClient extends grpc.Client { return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * UpsertObject RPC is the method to update a single object and add a new single object. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to upsert object. * * @generated from protobuf rpc: UpsertObject(payload.v1.Upsert.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -261,16 +148,7 @@ class FilterClient extends grpc.Client { return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * UpsertObject RPC is the method to update a single object and add a new single object. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to upsert object by bidirectional streaming. * * @generated from protobuf rpc: StreamUpsertObject(stream payload.v1.Upsert.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ @@ -279,21 +157,7 @@ class FilterClient extends grpc.Client { return this.makeBidiStreamRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 13 | INTERNAL | + * A method to upsert multiple objects. * * @generated from protobuf rpc: MultiUpsertObject(payload.v1.Upsert.MultiObjectRequest) returns (payload.v1.Object.Locations); */ diff --git a/src/vald/v1/vald/flush_pb.d.ts b/src/vald/v1/vald/flush_pb.d.ts new file mode 100644 index 0000000..4824920 --- /dev/null +++ b/src/vald/v1/vald/flush_pb.d.ts @@ -0,0 +1,26 @@ +/* eslint-disable */ +// @generated by protobuf-ts 2.9.4 with parameter add_pb_suffix,client_grpc1,generate_dependencies,keep_enum_prefix,ts_nocheck,use_proto_field_name,output_javascript,output_legacy_commonjs,eslint_disable +// @generated from protobuf file "vald/v1/vald/flush.proto" (package "vald.v1", syntax proto3) +// tslint:disable +// @ts-nocheck +// +// +// Copyright (C) 2019-2024 vdaas.org vald team +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// You may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// +/** + * @generated ServiceType for protobuf service vald.v1.Flush + */ +export declare const Flush: any; diff --git a/src/vald/v1/vald/flush_pb.grpc-client.d.ts b/src/vald/v1/vald/flush_pb.grpc-client.d.ts new file mode 100644 index 0000000..c19fa33 --- /dev/null +++ b/src/vald/v1/vald/flush_pb.grpc-client.d.ts @@ -0,0 +1,58 @@ +/* eslint-disable */ +// @generated by protobuf-ts 2.9.4 with parameter add_pb_suffix,client_grpc1,generate_dependencies,keep_enum_prefix,ts_nocheck,use_proto_field_name,output_javascript,output_legacy_commonjs,eslint_disable +// @generated from protobuf file "vald/v1/vald/flush.proto" (package "vald.v1", syntax proto3) +// tslint:disable +// @ts-nocheck +// +// +// Copyright (C) 2019-2024 vdaas.org vald team +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// You may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// +import type { BinaryWriteOptions } from "@protobuf-ts/runtime"; +import type { BinaryReadOptions } from "@protobuf-ts/runtime"; +import type { Info_Index_Count } from "../payload/payload_pb"; +import type { Flush_Request } from "../payload/payload_pb"; +import * as grpc from "@grpc/grpc-js"; +/** + * Flush service provides ways to flush all indexed vectors. + * + * @generated from protobuf service vald.v1.Flush + */ +export interface IFlushClient { + /** + * A method to flush all indexed vector. + * + * @generated from protobuf rpc: Flush(payload.v1.Flush.Request) returns (payload.v1.Info.Index.Count); + */ + flush(input: Flush_Request, metadata: grpc.Metadata, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Info_Index_Count) => void): grpc.ClientUnaryCall; + flush(input: Flush_Request, metadata: grpc.Metadata, callback: (err: grpc.ServiceError | null, value?: Info_Index_Count) => void): grpc.ClientUnaryCall; + flush(input: Flush_Request, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Info_Index_Count) => void): grpc.ClientUnaryCall; + flush(input: Flush_Request, callback: (err: grpc.ServiceError | null, value?: Info_Index_Count) => void): grpc.ClientUnaryCall; +} +/** + * Flush service provides ways to flush all indexed vectors. + * + * @generated from protobuf service vald.v1.Flush + */ +export declare class FlushClient extends grpc.Client implements IFlushClient { + private readonly _binaryOptions; + constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); + /** + * A method to flush all indexed vector. + * + * @generated from protobuf rpc: Flush(payload.v1.Flush.Request) returns (payload.v1.Info.Index.Count); + */ + flush(input: Flush_Request, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Info_Index_Count) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Info_Index_Count) => void), callback?: ((err: grpc.ServiceError | null, value?: Info_Index_Count) => void)): grpc.ClientUnaryCall; +} diff --git a/src/vald/v1/vald/flush_pb.grpc-client.js b/src/vald/v1/vald/flush_pb.grpc-client.js new file mode 100644 index 0000000..5ffee67 --- /dev/null +++ b/src/vald/v1/vald/flush_pb.grpc-client.js @@ -0,0 +1,70 @@ +/* eslint-disable */ +// @generated by protobuf-ts 2.9.4 with parameter add_pb_suffix,client_grpc1,generate_dependencies,keep_enum_prefix,ts_nocheck,use_proto_field_name,output_javascript,output_legacy_commonjs,eslint_disable +// @generated from protobuf file "vald/v1/vald/flush.proto" (package "vald.v1", syntax proto3) +// tslint:disable +// @ts-nocheck +// +// +// Copyright (C) 2019-2024 vdaas.org vald team +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// You may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.FlushClient = void 0; +/* eslint-disable */ +// @generated by protobuf-ts 2.9.4 with parameter add_pb_suffix,client_grpc1,generate_dependencies,keep_enum_prefix,ts_nocheck,use_proto_field_name,output_javascript,output_legacy_commonjs,eslint_disable +// @generated from protobuf file "vald/v1/vald/flush.proto" (package "vald.v1", syntax proto3) +// tslint:disable +// @ts-nocheck +// +// +// Copyright (C) 2019-2024 vdaas.org vald team +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// You may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// +const flush_pb_1 = require("./flush_pb"); +const grpc = require("@grpc/grpc-js"); +/** + * Flush service provides ways to flush all indexed vectors. + * + * @generated from protobuf service vald.v1.Flush + */ +class FlushClient extends grpc.Client { + constructor(address, credentials, options = {}, binaryOptions = {}) { + super(address, credentials, options); + this._binaryOptions = binaryOptions; + } + /** + * A method to flush all indexed vector. + * + * @generated from protobuf rpc: Flush(payload.v1.Flush.Request) returns (payload.v1.Info.Index.Count); + */ + flush(input, metadata, options, callback) { + const method = flush_pb_1.Flush.methods[0]; + return this.makeUnaryRequest(`/${flush_pb_1.Flush.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); + } +} +exports.FlushClient = FlushClient; diff --git a/src/vald/v1/vald/flush_pb.js b/src/vald/v1/vald/flush_pb.js new file mode 100644 index 0000000..5d65476 --- /dev/null +++ b/src/vald/v1/vald/flush_pb.js @@ -0,0 +1,56 @@ +/* eslint-disable */ +// @generated by protobuf-ts 2.9.4 with parameter add_pb_suffix,client_grpc1,generate_dependencies,keep_enum_prefix,ts_nocheck,use_proto_field_name,output_javascript,output_legacy_commonjs,eslint_disable +// @generated from protobuf file "vald/v1/vald/flush.proto" (package "vald.v1", syntax proto3) +// tslint:disable +// @ts-nocheck +// +// +// Copyright (C) 2019-2024 vdaas.org vald team +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// You may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.Flush = void 0; +/* eslint-disable */ +// @generated by protobuf-ts 2.9.4 with parameter add_pb_suffix,client_grpc1,generate_dependencies,keep_enum_prefix,ts_nocheck,use_proto_field_name,output_javascript,output_legacy_commonjs,eslint_disable +// @generated from protobuf file "vald/v1/vald/flush.proto" (package "vald.v1", syntax proto3) +// tslint:disable +// @ts-nocheck +// +// +// Copyright (C) 2019-2024 vdaas.org vald team +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// You may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// +const payload_pb_1 = require("../payload/payload_pb"); +const payload_pb_2 = require("../payload/payload_pb"); +const runtime_rpc_1 = require("@protobuf-ts/runtime-rpc"); +/** + * @generated ServiceType for protobuf service vald.v1.Flush + */ +exports.Flush = new runtime_rpc_1.ServiceType("vald.v1.Flush", [ + { name: "Flush", options: { "google.api.http": { delete: "/flush" } }, I: payload_pb_2.Flush_Request, O: payload_pb_1.Info_Index_Count } +]); diff --git a/src/vald/v1/vald/index.d.ts b/src/vald/v1/vald/index.d.ts index acd6f92..d725048 100644 --- a/src/vald/v1/vald/index.d.ts +++ b/src/vald/v1/vald/index.d.ts @@ -1,5 +1,7 @@ import filter = require("./filter_pb"); import filter_grpc = require("./filter_pb.grpc-client"); +import flush = require("./flush_pb"); +import flush_grpc = require("./flush_pb.grpc-client"); import insert = require("./insert_pb"); import insert_grpc = require("./insert_pb.grpc-client"); import object = require("./object_pb"); @@ -17,6 +19,8 @@ import upsert_grpc = require("./upsert_pb.grpc-client"); declare const _default: { filter: typeof filter, filter_grpc: typeof filter_grpc, + flush: typeof flush, + flush_grpc: typeof flush_grpc, insert: typeof insert, insert_grpc: typeof insert_grpc, object: typeof object, diff --git a/src/vald/v1/vald/index.js b/src/vald/v1/vald/index.js index b360d3e..45ff175 100644 --- a/src/vald/v1/vald/index.js +++ b/src/vald/v1/vald/index.js @@ -1,5 +1,7 @@ module.exports.filter = require("./filter_pb"); module.exports.filter_grpc = require("./filter_pb.grpc-client"); +module.exports.flush = require("./flush_pb"); +module.exports.flush_grpc = require("./flush_pb.grpc-client"); module.exports.insert = require("./insert_pb"); module.exports.insert_grpc = require("./insert_pb.grpc-client"); module.exports.object = require("./object_pb"); diff --git a/src/vald/v1/vald/index_pb.grpc-client.d.ts b/src/vald/v1/vald/index_pb.grpc-client.d.ts index b984081..1e7c248 100644 --- a/src/vald/v1/vald/index_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/index_pb.grpc-client.d.ts @@ -30,14 +30,12 @@ import type { Info_Index_Count } from "../payload/payload_pb"; import type { Empty } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Overview * Represent the index manager service. * * @generated from protobuf service vald.v1.Index */ export interface IIndexClient { /** - * Overview * Represent the RPC to get the index information. * * @generated from protobuf rpc: IndexInfo(payload.v1.Empty) returns (payload.v1.Info.Index.Count); @@ -47,7 +45,6 @@ export interface IIndexClient { indexInfo(input: Empty, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Info_Index_Count) => void): grpc.ClientUnaryCall; indexInfo(input: Empty, callback: (err: grpc.ServiceError | null, value?: Info_Index_Count) => void): grpc.ClientUnaryCall; /** - * Overview * Represent the RPC to get the index information for each agents. * * @generated from protobuf rpc: IndexDetail(payload.v1.Empty) returns (payload.v1.Info.Index.Detail); @@ -57,7 +54,6 @@ export interface IIndexClient { indexDetail(input: Empty, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Info_Index_Detail) => void): grpc.ClientUnaryCall; indexDetail(input: Empty, callback: (err: grpc.ServiceError | null, value?: Info_Index_Detail) => void): grpc.ClientUnaryCall; /** - * Overview * Represent the RPC to get the index statistics. * * @generated from protobuf rpc: IndexStatistics(payload.v1.Empty) returns (payload.v1.Info.Index.Statistics); @@ -67,7 +63,6 @@ export interface IIndexClient { indexStatistics(input: Empty, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Info_Index_Statistics) => void): grpc.ClientUnaryCall; indexStatistics(input: Empty, callback: (err: grpc.ServiceError | null, value?: Info_Index_Statistics) => void): grpc.ClientUnaryCall; /** - * Overview * Represent the RPC to get the index statistics for each agents. * * @generated from protobuf rpc: IndexStatisticsDetail(payload.v1.Empty) returns (payload.v1.Info.Index.StatisticsDetail); @@ -77,7 +72,6 @@ export interface IIndexClient { indexStatisticsDetail(input: Empty, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Info_Index_StatisticsDetail) => void): grpc.ClientUnaryCall; indexStatisticsDetail(input: Empty, callback: (err: grpc.ServiceError | null, value?: Info_Index_StatisticsDetail) => void): grpc.ClientUnaryCall; /** - * Overview * Represent the RPC to get the index property. * * @generated from protobuf rpc: IndexProperty(payload.v1.Empty) returns (payload.v1.Info.Index.PropertyDetail); @@ -88,7 +82,6 @@ export interface IIndexClient { indexProperty(input: Empty, callback: (err: grpc.ServiceError | null, value?: Info_Index_PropertyDetail) => void): grpc.ClientUnaryCall; } /** - * Overview * Represent the index manager service. * * @generated from protobuf service vald.v1.Index @@ -97,35 +90,30 @@ export declare class IndexClient extends grpc.Client implements IIndexClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * Overview * Represent the RPC to get the index information. * * @generated from protobuf rpc: IndexInfo(payload.v1.Empty) returns (payload.v1.Info.Index.Count); */ indexInfo(input: Empty, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Info_Index_Count) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Info_Index_Count) => void), callback?: ((err: grpc.ServiceError | null, value?: Info_Index_Count) => void)): grpc.ClientUnaryCall; /** - * Overview * Represent the RPC to get the index information for each agents. * * @generated from protobuf rpc: IndexDetail(payload.v1.Empty) returns (payload.v1.Info.Index.Detail); */ indexDetail(input: Empty, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Info_Index_Detail) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Info_Index_Detail) => void), callback?: ((err: grpc.ServiceError | null, value?: Info_Index_Detail) => void)): grpc.ClientUnaryCall; /** - * Overview * Represent the RPC to get the index statistics. * * @generated from protobuf rpc: IndexStatistics(payload.v1.Empty) returns (payload.v1.Info.Index.Statistics); */ indexStatistics(input: Empty, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Info_Index_Statistics) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Info_Index_Statistics) => void), callback?: ((err: grpc.ServiceError | null, value?: Info_Index_Statistics) => void)): grpc.ClientUnaryCall; /** - * Overview * Represent the RPC to get the index statistics for each agents. * * @generated from protobuf rpc: IndexStatisticsDetail(payload.v1.Empty) returns (payload.v1.Info.Index.StatisticsDetail); */ indexStatisticsDetail(input: Empty, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Info_Index_StatisticsDetail) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Info_Index_StatisticsDetail) => void), callback?: ((err: grpc.ServiceError | null, value?: Info_Index_StatisticsDetail) => void)): grpc.ClientUnaryCall; /** - * Overview * Represent the RPC to get the index property. * * @generated from protobuf rpc: IndexProperty(payload.v1.Empty) returns (payload.v1.Info.Index.PropertyDetail); diff --git a/src/vald/v1/vald/index_pb.grpc-client.js b/src/vald/v1/vald/index_pb.grpc-client.js index ad25962..4e426a3 100644 --- a/src/vald/v1/vald/index_pb.grpc-client.js +++ b/src/vald/v1/vald/index_pb.grpc-client.js @@ -48,7 +48,6 @@ exports.IndexClient = void 0; const index_pb_1 = require("./index_pb"); const grpc = require("@grpc/grpc-js"); /** - * Overview * Represent the index manager service. * * @generated from protobuf service vald.v1.Index @@ -59,7 +58,6 @@ class IndexClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * Overview * Represent the RPC to get the index information. * * @generated from protobuf rpc: IndexInfo(payload.v1.Empty) returns (payload.v1.Info.Index.Count); @@ -69,7 +67,6 @@ class IndexClient extends grpc.Client { return this.makeUnaryRequest(`/${index_pb_1.Index.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview * Represent the RPC to get the index information for each agents. * * @generated from protobuf rpc: IndexDetail(payload.v1.Empty) returns (payload.v1.Info.Index.Detail); @@ -79,7 +76,6 @@ class IndexClient extends grpc.Client { return this.makeUnaryRequest(`/${index_pb_1.Index.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview * Represent the RPC to get the index statistics. * * @generated from protobuf rpc: IndexStatistics(payload.v1.Empty) returns (payload.v1.Info.Index.Statistics); @@ -89,7 +85,6 @@ class IndexClient extends grpc.Client { return this.makeUnaryRequest(`/${index_pb_1.Index.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview * Represent the RPC to get the index statistics for each agents. * * @generated from protobuf rpc: IndexStatisticsDetail(payload.v1.Empty) returns (payload.v1.Info.Index.StatisticsDetail); @@ -99,7 +94,6 @@ class IndexClient extends grpc.Client { return this.makeUnaryRequest(`/${index_pb_1.Index.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview * Represent the RPC to get the index property. * * @generated from protobuf rpc: IndexProperty(payload.v1.Empty) returns (payload.v1.Info.Index.PropertyDetail); diff --git a/src/vald/v1/vald/insert_pb.grpc-client.d.ts b/src/vald/v1/vald/insert_pb.grpc-client.d.ts index 7f0c63b..e9572cd 100644 --- a/src/vald/v1/vald/insert_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/insert_pb.grpc-client.d.ts @@ -29,36 +29,13 @@ import type { Object_Location } from "../payload/payload_pb"; import type { Insert_Request } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Overview - * Insert Service is responsible for inserting new vectors into the `vald-agent`. + * Insert service provides ways to add new vectors. * * @generated from protobuf service vald.v1.Insert */ export interface IInsertClient { /** - * Overview - * Inset RPC is the method to add a new single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to add a new single vector. * * @generated from protobuf rpc: Insert(payload.v1.Insert.Request) returns (payload.v1.Object.Location); */ @@ -67,68 +44,14 @@ export interface IInsertClient { insert(input: Insert_Request, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; insert(input: Insert_Request, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; /** - * Overview - * StreamInsert RPC is the method to add new multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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 vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to add new multiple vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamInsert(stream payload.v1.Insert.Request) returns (stream payload.v1.Object.StreamLocation); */ streamInsert(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamInsert(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to add new multiple vectors in a single request. * * @generated from protobuf rpc: MultiInsert(payload.v1.Insert.MultiRequest) returns (payload.v1.Object.Locations); */ @@ -138,8 +61,7 @@ export interface IInsertClient { multiInsert(input: Insert_MultiRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; } /** - * Overview - * Insert Service is responsible for inserting new vectors into the `vald-agent`. + * Insert service provides ways to add new vectors. * * @generated from protobuf service vald.v1.Insert */ @@ -147,95 +69,19 @@ export declare class InsertClient extends grpc.Client implements IInsertClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * Overview - * Inset RPC is the method to add a new single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to add a new single vector. * * @generated from protobuf rpc: Insert(payload.v1.Insert.Request) returns (payload.v1.Object.Location); */ insert(input: Insert_Request, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Location) => void)): grpc.ClientUnaryCall; /** - * Overview - * StreamInsert RPC is the method to add new multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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 vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to add new multiple vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamInsert(stream payload.v1.Insert.Request) returns (stream payload.v1.Object.StreamLocation); */ streamInsert(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to add new multiple vectors in a single request. * * @generated from protobuf rpc: MultiInsert(payload.v1.Insert.MultiRequest) returns (payload.v1.Object.Locations); */ diff --git a/src/vald/v1/vald/insert_pb.grpc-client.js b/src/vald/v1/vald/insert_pb.grpc-client.js index f231cd8..a408f12 100644 --- a/src/vald/v1/vald/insert_pb.grpc-client.js +++ b/src/vald/v1/vald/insert_pb.grpc-client.js @@ -48,8 +48,7 @@ exports.InsertClient = void 0; const insert_pb_1 = require("./insert_pb"); const grpc = require("@grpc/grpc-js"); /** - * Overview - * Insert Service is responsible for inserting new vectors into the `vald-agent`. + * Insert service provides ways to add new vectors. * * @generated from protobuf service vald.v1.Insert */ @@ -59,29 +58,7 @@ class InsertClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * Overview - * Inset RPC is the method to add a new single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to add a new single vector. * * @generated from protobuf rpc: Insert(payload.v1.Insert.Request) returns (payload.v1.Object.Location); */ @@ -90,33 +67,7 @@ class InsertClient extends grpc.Client { return this.makeUnaryRequest(`/${insert_pb_1.Insert.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * StreamInsert RPC is the method to add new multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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 vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to add new multiple vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamInsert(stream payload.v1.Insert.Request) returns (stream payload.v1.Object.StreamLocation); */ @@ -125,35 +76,7 @@ class InsertClient extends grpc.Client { return this.makeBidiStreamRequest(`/${insert_pb_1.Insert.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Request ID is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to add new multiple vectors in a single request. * * @generated from protobuf rpc: MultiInsert(payload.v1.Insert.MultiRequest) returns (payload.v1.Object.Locations); */ diff --git a/src/vald/v1/vald/object_pb.grpc-client.d.ts b/src/vald/v1/vald/object_pb.grpc-client.d.ts index 14edc1d..51bede0 100644 --- a/src/vald/v1/vald/object_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/object_pb.grpc-client.d.ts @@ -32,36 +32,13 @@ import type { Object_VectorRequest } from "../payload/payload_pb"; import type { Object_ID } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Overview - * Object Service is responsible for getting inserted vectors and checking whether vectors are inserted into the `vald-agent`. + * Object service provides ways to fetch indexed vectors. * * @generated from protobuf service vald.v1.Object */ export interface IObjectClient { /** - * Overview - * Exists RPC is the method to check that a vector exists in the `vald-agent`. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to check whether a specified ID is indexed or not. * * @generated from protobuf rpc: Exists(payload.v1.Object.ID) returns (payload.v1.Object.ID); */ @@ -70,29 +47,7 @@ export interface IObjectClient { exists(input: Object_ID, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_ID) => void): grpc.ClientUnaryCall; exists(input: Object_ID, callback: (err: grpc.ServiceError | null, value?: Object_ID) => void): grpc.ClientUnaryCall; /** - * Overview - * GetObject RPC is the method to get the metadata of a vector inserted into the `vald-agent`. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to fetch a vector. * * @generated from protobuf rpc: GetObject(payload.v1.Object.VectorRequest) returns (payload.v1.Object.Vector); */ @@ -101,59 +56,21 @@ export interface IObjectClient { getObject(input: Object_VectorRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Vector) => void): grpc.ClientUnaryCall; getObject(input: Object_VectorRequest, callback: (err: grpc.ServiceError | null, value?: Object_Vector) => void): grpc.ClientUnaryCall; /** - * Overview - * StreamGetObject RPC is the method to get the metadata of multiple existing vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * Using the bidirectional streaming RPC, the GetObject request can be communicated in any order between client and server. - * Each Upsert request and response are independent. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to fetch vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamGetObject(stream payload.v1.Object.VectorRequest) returns (stream payload.v1.Object.StreamVector); */ streamGetObject(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamGetObject(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * Overview * A method to get all the vectors with server streaming - * --- - * Status Code - * TODO - * --- - * Troubleshooting - * TODO * * @generated from protobuf rpc: StreamListObject(payload.v1.Object.List.Request) returns (stream payload.v1.Object.List.Response); */ streamListObject(input: Object_List_Request, metadata?: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientReadableStream; streamListObject(input: Object_List_Request, options?: grpc.CallOptions): grpc.ClientReadableStream; /** - * Overview * Represent the RPC to get the vector metadata. This RPC is mainly used for index correction process - * --- - * Status Code - * TODO - * --- - * Troubleshooting - * TODO * * @generated from protobuf rpc: GetTimestamp(payload.v1.Object.TimestampRequest) returns (payload.v1.Object.Timestamp); */ @@ -163,8 +80,7 @@ export interface IObjectClient { getTimestamp(input: Object_TimestampRequest, callback: (err: grpc.ServiceError | null, value?: Object_Timestamp) => void): grpc.ClientUnaryCall; } /** - * Overview - * Object Service is responsible for getting inserted vectors and checking whether vectors are inserted into the `vald-agent`. + * Object service provides ways to fetch indexed vectors. * * @generated from protobuf service vald.v1.Object */ @@ -172,113 +88,31 @@ export declare class ObjectClient extends grpc.Client implements IObjectClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * Overview - * Exists RPC is the method to check that a vector exists in the `vald-agent`. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to check whether a specified ID is indexed or not. * * @generated from protobuf rpc: Exists(payload.v1.Object.ID) returns (payload.v1.Object.ID); */ exists(input: Object_ID, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_ID) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_ID) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_ID) => void)): grpc.ClientUnaryCall; /** - * Overview - * GetObject RPC is the method to get the metadata of a vector inserted into the `vald-agent`. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to fetch a vector. * * @generated from protobuf rpc: GetObject(payload.v1.Object.VectorRequest) returns (payload.v1.Object.Vector); */ getObject(input: Object_VectorRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Vector) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Vector) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Vector) => void)): grpc.ClientUnaryCall; /** - * Overview - * StreamGetObject RPC is the method to get the metadata of multiple existing vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * Using the bidirectional streaming RPC, the GetObject request can be communicated in any order between client and server. - * Each Upsert request and response are independent. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to fetch vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamGetObject(stream payload.v1.Object.VectorRequest) returns (stream payload.v1.Object.StreamVector); */ streamGetObject(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * Overview * A method to get all the vectors with server streaming - * --- - * Status Code - * TODO - * --- - * Troubleshooting - * TODO * * @generated from protobuf rpc: StreamListObject(payload.v1.Object.List.Request) returns (stream payload.v1.Object.List.Response); */ streamListObject(input: Object_List_Request, metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientReadableStream; /** - * Overview * Represent the RPC to get the vector metadata. This RPC is mainly used for index correction process - * --- - * Status Code - * TODO - * --- - * Troubleshooting - * TODO * * @generated from protobuf rpc: GetTimestamp(payload.v1.Object.TimestampRequest) returns (payload.v1.Object.Timestamp); */ diff --git a/src/vald/v1/vald/object_pb.grpc-client.js b/src/vald/v1/vald/object_pb.grpc-client.js index 4a7469d..d9bc2a5 100644 --- a/src/vald/v1/vald/object_pb.grpc-client.js +++ b/src/vald/v1/vald/object_pb.grpc-client.js @@ -48,8 +48,7 @@ exports.ObjectClient = void 0; const object_pb_1 = require("./object_pb"); const grpc = require("@grpc/grpc-js"); /** - * Overview - * Object Service is responsible for getting inserted vectors and checking whether vectors are inserted into the `vald-agent`. + * Object service provides ways to fetch indexed vectors. * * @generated from protobuf service vald.v1.Object */ @@ -59,29 +58,7 @@ class ObjectClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * Overview - * Exists RPC is the method to check that a vector exists in the `vald-agent`. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to check whether a specified ID is indexed or not. * * @generated from protobuf rpc: Exists(payload.v1.Object.ID) returns (payload.v1.Object.ID); */ @@ -90,29 +67,7 @@ class ObjectClient extends grpc.Client { return this.makeUnaryRequest(`/${object_pb_1.Object.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * GetObject RPC is the method to get the metadata of a vector inserted into the `vald-agent`. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to fetch a vector. * * @generated from protobuf rpc: GetObject(payload.v1.Object.VectorRequest) returns (payload.v1.Object.Vector); */ @@ -121,31 +76,7 @@ class ObjectClient extends grpc.Client { return this.makeUnaryRequest(`/${object_pb_1.Object.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * StreamGetObject RPC is the method to get the metadata of multiple existing vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * Using the bidirectional streaming RPC, the GetObject request can be communicated in any order between client and server. - * Each Upsert request and response are independent. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to fetch vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamGetObject(stream payload.v1.Object.VectorRequest) returns (stream payload.v1.Object.StreamVector); */ @@ -154,14 +85,7 @@ class ObjectClient extends grpc.Client { return this.makeBidiStreamRequest(`/${object_pb_1.Object.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * Overview * A method to get all the vectors with server streaming - * --- - * Status Code - * TODO - * --- - * Troubleshooting - * TODO * * @generated from protobuf rpc: StreamListObject(payload.v1.Object.List.Request) returns (stream payload.v1.Object.List.Response); */ @@ -170,14 +94,7 @@ class ObjectClient extends grpc.Client { return this.makeServerStreamRequest(`/${object_pb_1.Object.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options); } /** - * Overview * Represent the RPC to get the vector metadata. This RPC is mainly used for index correction process - * --- - * Status Code - * TODO - * --- - * Troubleshooting - * TODO * * @generated from protobuf rpc: GetTimestamp(payload.v1.Object.TimestampRequest) returns (payload.v1.Object.Timestamp); */ diff --git a/src/vald/v1/vald/remove_pb.grpc-client.d.ts b/src/vald/v1/vald/remove_pb.grpc-client.d.ts index 302c419..60bc939 100644 --- a/src/vald/v1/vald/remove_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/remove_pb.grpc-client.d.ts @@ -30,37 +30,13 @@ import type { Object_Location } from "../payload/payload_pb"; import type { Remove_Request } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Overview - * Remove Service is responsible for removing vectors indexed in the `vald-agent`. + * Remove service provides ways to remove indexed vectors. * * @generated from protobuf service vald.v1.Remove */ export interface IRemoveClient { /** - * Overview - * Remove RPC is the method to remove a single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to remove an indexed vector. * * @generated from protobuf rpc: Remove(payload.v1.Remove.Request) returns (payload.v1.Object.Location); */ @@ -69,33 +45,7 @@ export interface IRemoveClient { remove(input: Remove_Request, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; remove(input: Remove_Request, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; /** - * 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.
- * This design allows for versatile deletion operations, facilitating tasks such as removing data within a specific time range. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. + * A method to remove an indexed vector based on timestamp. * * @generated from protobuf rpc: RemoveByTimestamp(payload.v1.Remove.TimestampRequest) returns (payload.v1.Object.Locations); */ @@ -104,70 +54,14 @@ export interface IRemoveClient { removeByTimestamp(input: Remove_TimestampRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; removeByTimestamp(input: Remove_TimestampRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; /** - * 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. - * It's the recommended method to remove a large number of vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - * * @generated from protobuf rpc: StreamRemove(stream payload.v1.Remove.Request) returns (stream payload.v1.Object.StreamLocation); */ streamRemove(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamRemove(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to remove multiple indexed vectors in a single request. * * @generated from protobuf rpc: MultiRemove(payload.v1.Remove.MultiRequest) returns (payload.v1.Object.Locations); */ @@ -177,8 +71,7 @@ export interface IRemoveClient { multiRemove(input: Remove_MultiRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; } /** - * Overview - * Remove Service is responsible for removing vectors indexed in the `vald-agent`. + * Remove service provides ways to remove indexed vectors. * * @generated from protobuf service vald.v1.Remove */ @@ -186,130 +79,25 @@ export declare class RemoveClient extends grpc.Client implements IRemoveClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * Overview - * Remove RPC is the method to remove a single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to remove an indexed vector. * * @generated from protobuf rpc: Remove(payload.v1.Remove.Request) returns (payload.v1.Object.Location); */ remove(input: Remove_Request, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Location) => void)): grpc.ClientUnaryCall; /** - * 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.
- * This design allows for versatile deletion operations, facilitating tasks such as removing data within a specific time range. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. + * A method to remove an indexed vector based on timestamp. * * @generated from protobuf rpc: RemoveByTimestamp(payload.v1.Remove.TimestampRequest) returns (payload.v1.Object.Locations); */ removeByTimestamp(input: Remove_TimestampRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Locations) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Locations) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Locations) => void)): grpc.ClientUnaryCall; /** - * 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. - * It's the recommended method to remove a large number of vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - * * @generated from protobuf rpc: StreamRemove(stream payload.v1.Remove.Request) returns (stream payload.v1.Object.StreamLocation); */ streamRemove(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to remove multiple indexed vectors in a single request. * * @generated from protobuf rpc: MultiRemove(payload.v1.Remove.MultiRequest) returns (payload.v1.Object.Locations); */ diff --git a/src/vald/v1/vald/remove_pb.grpc-client.js b/src/vald/v1/vald/remove_pb.grpc-client.js index bd6c943..11780a2 100644 --- a/src/vald/v1/vald/remove_pb.grpc-client.js +++ b/src/vald/v1/vald/remove_pb.grpc-client.js @@ -48,8 +48,7 @@ exports.RemoveClient = void 0; const remove_pb_1 = require("./remove_pb"); const grpc = require("@grpc/grpc-js"); /** - * Overview - * Remove Service is responsible for removing vectors indexed in the `vald-agent`. + * Remove service provides ways to remove indexed vectors. * * @generated from protobuf service vald.v1.Remove */ @@ -59,30 +58,7 @@ class RemoveClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * Overview - * Remove RPC is the method to remove a single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to remove an indexed vector. * * @generated from protobuf rpc: Remove(payload.v1.Remove.Request) returns (payload.v1.Object.Location); */ @@ -91,33 +67,7 @@ class RemoveClient extends grpc.Client { return this.makeUnaryRequest(`/${remove_pb_1.Remove.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * 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.
- * This design allows for versatile deletion operations, facilitating tasks such as removing data within a specific time range. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 13 | INTERNAL | - * --- - * 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. + * A method to remove an indexed vector based on timestamp. * * @generated from protobuf rpc: RemoveByTimestamp(payload.v1.Remove.TimestampRequest) returns (payload.v1.Object.Locations); */ @@ -126,36 +76,8 @@ class RemoveClient extends grpc.Client { return this.makeUnaryRequest(`/${remove_pb_1.Remove.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * 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. - * It's the recommended method to remove a large number of vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | - * * @generated from protobuf rpc: StreamRemove(stream payload.v1.Remove.Request) returns (stream payload.v1.Object.StreamLocation); */ streamRemove(metadata, options) { @@ -163,35 +85,7 @@ class RemoveClient extends grpc.Client { return this.makeBidiStreamRequest(`/${remove_pb_1.Remove.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to remove multiple indexed vectors in a single request. * * @generated from protobuf rpc: MultiRemove(payload.v1.Remove.MultiRequest) returns (payload.v1.Object.Locations); */ diff --git a/src/vald/v1/vald/search_pb.grpc-client.d.ts b/src/vald/v1/vald/search_pb.grpc-client.d.ts index 296a7c3..e0f2eef 100644 --- a/src/vald/v1/vald/search_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/search_pb.grpc-client.d.ts @@ -31,37 +31,13 @@ import type { Search_Response } from "../payload/payload_pb"; import type { Search_Request } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Overview - * Search Service is responsible for searching vectors similar to the user request vector from `vald-agent`. + * Search service provides ways to search indexed vectors. * * @generated from protobuf service vald.v1.Search */ export interface ISearchClient { /** - * Overview - * Search RPC is the method to search vector(s) similar to the request vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by a raw vector. * * @generated from protobuf rpc: Search(payload.v1.Search.Request) returns (payload.v1.Search.Response); */ @@ -70,31 +46,7 @@ export interface ISearchClient { search(input: Search_Request, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Search_Response) => void): grpc.ClientUnaryCall; search(input: Search_Request, callback: (err: grpc.ServiceError | null, value?: Search_Response) => void): grpc.ClientUnaryCall; /** - * Overview - * SearchByID RPC is the method to search similar vectors using a user-defined vector ID.
- * The vector with the same requested ID should be indexed into the `vald-agent` before searching. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by ID. * * @generated from protobuf rpc: SearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response); */ @@ -103,99 +55,21 @@ export interface ISearchClient { searchByID(input: Search_IDRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Search_Response) => void): grpc.ClientUnaryCall; searchByID(input: Search_IDRequest, callback: (err: grpc.ServiceError | null, value?: Search_Response) => void): grpc.ClientUnaryCall; /** - * Overview - * StreamSearch RPC is the method to search vectors with multi queries(vectors) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple vectors. * * @generated from protobuf rpc: StreamSearch(stream payload.v1.Search.Request) returns (stream payload.v1.Search.StreamResponse); */ streamSearch(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamSearch(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * Overview - * StreamSearchByID RPC is the method to search vectors with multi queries(IDs) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple IDs. * * @generated from protobuf rpc: StreamSearchByID(stream payload.v1.Search.IDRequest) returns (stream payload.v1.Search.StreamResponse); */ streamSearchByID(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamSearchByID(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple vectors in a single request. * * @generated from protobuf rpc: MultiSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses); */ @@ -204,35 +78,7 @@ export interface ISearchClient { multiSearch(input: Search_MultiRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Search_Responses) => void): grpc.ClientUnaryCall; multiSearch(input: Search_MultiRequest, callback: (err: grpc.ServiceError | null, value?: Search_Responses) => void): grpc.ClientUnaryCall; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple IDs in a single request. * * @generated from protobuf rpc: MultiSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses); */ @@ -241,30 +87,7 @@ export interface ISearchClient { multiSearchByID(input: Search_MultiIDRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Search_Responses) => void): grpc.ClientUnaryCall; multiSearchByID(input: Search_MultiIDRequest, callback: (err: grpc.ServiceError | null, value?: Search_Responses) => void): grpc.ClientUnaryCall; /** - * Overview - * LinearSearch RPC is the method to linear search vector(s) similar to the request vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by a raw vector. * * @generated from protobuf rpc: LinearSearch(payload.v1.Search.Request) returns (payload.v1.Search.Response); */ @@ -273,32 +96,7 @@ export interface ISearchClient { linearSearch(input: Search_Request, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Search_Response) => void): grpc.ClientUnaryCall; linearSearch(input: Search_Request, callback: (err: grpc.ServiceError | null, value?: Search_Response) => void): grpc.ClientUnaryCall; /** - * Overview - * LinearSearchByID RPC is the method to linear search similar vectors using a user-defined vector ID.
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by ID. * * @generated from protobuf rpc: LinearSearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response); */ @@ -307,99 +105,22 @@ export interface ISearchClient { linearSearchByID(input: Search_IDRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Search_Response) => void): grpc.ClientUnaryCall; linearSearchByID(input: Search_IDRequest, callback: (err: grpc.ServiceError | null, value?: Search_Response) => void): grpc.ClientUnaryCall; /** - * Overview - * StreamLinearSearch RPC is the method to linear search vectors with multi queries(vectors) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple vectors. * * @generated from protobuf rpc: StreamLinearSearch(stream payload.v1.Search.Request) returns (stream payload.v1.Search.StreamResponse); */ streamLinearSearch(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamLinearSearch(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * Overview - * StreamLinearSearchByID RPC is the method to linear search vectors with multi queries(IDs) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple IDs. * * @generated from protobuf rpc: StreamLinearSearchByID(stream payload.v1.Search.IDRequest) returns (stream payload.v1.Search.StreamResponse); */ streamLinearSearchByID(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamLinearSearchByID(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple vectors in a single + * request. * * @generated from protobuf rpc: MultiLinearSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses); */ @@ -408,35 +129,8 @@ export interface ISearchClient { multiLinearSearch(input: Search_MultiRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Search_Responses) => void): grpc.ClientUnaryCall; multiLinearSearch(input: Search_MultiRequest, callback: (err: grpc.ServiceError | null, value?: Search_Responses) => void): grpc.ClientUnaryCall; /** - * 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. - *
- * // --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple IDs in a single + * request. * * @generated from protobuf rpc: MultiLinearSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses); */ @@ -446,8 +140,7 @@ export interface ISearchClient { multiLinearSearchByID(input: Search_MultiIDRequest, callback: (err: grpc.ServiceError | null, value?: Search_Responses) => void): grpc.ClientUnaryCall; } /** - * Overview - * Search Service is responsible for searching vectors similar to the user request vector from `vald-agent`. + * Search service provides ways to search indexed vectors. * * @generated from protobuf service vald.v1.Search */ @@ -455,380 +148,75 @@ export declare class SearchClient extends grpc.Client implements ISearchClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * Overview - * Search RPC is the method to search vector(s) similar to the request vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by a raw vector. * * @generated from protobuf rpc: Search(payload.v1.Search.Request) returns (payload.v1.Search.Response); */ search(input: Search_Request, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Response) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Response) => void), callback?: ((err: grpc.ServiceError | null, value?: Search_Response) => void)): grpc.ClientUnaryCall; /** - * Overview - * SearchByID RPC is the method to search similar vectors using a user-defined vector ID.
- * The vector with the same requested ID should be indexed into the `vald-agent` before searching. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by ID. * * @generated from protobuf rpc: SearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response); */ searchByID(input: Search_IDRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Response) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Response) => void), callback?: ((err: grpc.ServiceError | null, value?: Search_Response) => void)): grpc.ClientUnaryCall; /** - * Overview - * StreamSearch RPC is the method to search vectors with multi queries(vectors) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple vectors. * * @generated from protobuf rpc: StreamSearch(stream payload.v1.Search.Request) returns (stream payload.v1.Search.StreamResponse); */ streamSearch(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * Overview - * StreamSearchByID RPC is the method to search vectors with multi queries(IDs) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple IDs. * * @generated from protobuf rpc: StreamSearchByID(stream payload.v1.Search.IDRequest) returns (stream payload.v1.Search.StreamResponse); */ streamSearchByID(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple vectors in a single request. * * @generated from protobuf rpc: MultiSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses); */ multiSearch(input: Search_MultiRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Responses) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Responses) => void), callback?: ((err: grpc.ServiceError | null, value?: Search_Responses) => void)): grpc.ClientUnaryCall; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple IDs in a single request. * * @generated from protobuf rpc: MultiSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses); */ multiSearchByID(input: Search_MultiIDRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Responses) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Responses) => void), callback?: ((err: grpc.ServiceError | null, value?: Search_Responses) => void)): grpc.ClientUnaryCall; /** - * Overview - * LinearSearch RPC is the method to linear search vector(s) similar to the request vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by a raw vector. * * @generated from protobuf rpc: LinearSearch(payload.v1.Search.Request) returns (payload.v1.Search.Response); */ linearSearch(input: Search_Request, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Response) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Response) => void), callback?: ((err: grpc.ServiceError | null, value?: Search_Response) => void)): grpc.ClientUnaryCall; /** - * Overview - * LinearSearchByID RPC is the method to linear search similar vectors using a user-defined vector ID.
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by ID. * * @generated from protobuf rpc: LinearSearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response); */ linearSearchByID(input: Search_IDRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Response) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Response) => void), callback?: ((err: grpc.ServiceError | null, value?: Search_Response) => void)): grpc.ClientUnaryCall; /** - * Overview - * StreamLinearSearch RPC is the method to linear search vectors with multi queries(vectors) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple vectors. * * @generated from protobuf rpc: StreamLinearSearch(stream payload.v1.Search.Request) returns (stream payload.v1.Search.StreamResponse); */ streamLinearSearch(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * Overview - * StreamLinearSearchByID RPC is the method to linear search vectors with multi queries(IDs) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple IDs. * * @generated from protobuf rpc: StreamLinearSearchByID(stream payload.v1.Search.IDRequest) returns (stream payload.v1.Search.StreamResponse); */ streamLinearSearchByID(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple vectors in a single + * request. * * @generated from protobuf rpc: MultiLinearSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses); */ multiLinearSearch(input: Search_MultiRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Responses) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Search_Responses) => void), callback?: ((err: grpc.ServiceError | null, value?: Search_Responses) => void)): grpc.ClientUnaryCall; /** - * 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. - *
- * // --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple IDs in a single + * request. * * @generated from protobuf rpc: MultiLinearSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses); */ diff --git a/src/vald/v1/vald/search_pb.grpc-client.js b/src/vald/v1/vald/search_pb.grpc-client.js index 0f8985b..56197c4 100644 --- a/src/vald/v1/vald/search_pb.grpc-client.js +++ b/src/vald/v1/vald/search_pb.grpc-client.js @@ -48,8 +48,7 @@ exports.SearchClient = void 0; const search_pb_1 = require("./search_pb"); const grpc = require("@grpc/grpc-js"); /** - * Overview - * Search Service is responsible for searching vectors similar to the user request vector from `vald-agent`. + * Search service provides ways to search indexed vectors. * * @generated from protobuf service vald.v1.Search */ @@ -59,30 +58,7 @@ class SearchClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * Overview - * Search RPC is the method to search vector(s) similar to the request vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by a raw vector. * * @generated from protobuf rpc: Search(payload.v1.Search.Request) returns (payload.v1.Search.Response); */ @@ -91,31 +67,7 @@ class SearchClient extends grpc.Client { return this.makeUnaryRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * SearchByID RPC is the method to search similar vectors using a user-defined vector ID.
- * The vector with the same requested ID should be indexed into the `vald-agent` before searching. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by ID. * * @generated from protobuf rpc: SearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response); */ @@ -124,32 +76,7 @@ class SearchClient extends grpc.Client { return this.makeUnaryRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * StreamSearch RPC is the method to search vectors with multi queries(vectors) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple vectors. * * @generated from protobuf rpc: StreamSearch(stream payload.v1.Search.Request) returns (stream payload.v1.Search.StreamResponse); */ @@ -158,32 +85,7 @@ class SearchClient extends grpc.Client { return this.makeBidiStreamRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * Overview - * StreamSearchByID RPC is the method to search vectors with multi queries(IDs) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple IDs. * * @generated from protobuf rpc: StreamSearchByID(stream payload.v1.Search.IDRequest) returns (stream payload.v1.Search.StreamResponse); */ @@ -192,35 +94,7 @@ class SearchClient extends grpc.Client { return this.makeBidiStreamRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple vectors in a single request. * * @generated from protobuf rpc: MultiSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses); */ @@ -229,35 +103,7 @@ class SearchClient extends grpc.Client { return this.makeUnaryRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to search indexed vectors by multiple IDs in a single request. * * @generated from protobuf rpc: MultiSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses); */ @@ -266,30 +112,7 @@ class SearchClient extends grpc.Client { return this.makeUnaryRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * LinearSearch RPC is the method to linear search vector(s) similar to the request vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by a raw vector. * * @generated from protobuf rpc: LinearSearch(payload.v1.Search.Request) returns (payload.v1.Search.Response); */ @@ -298,32 +121,7 @@ class SearchClient extends grpc.Client { return this.makeUnaryRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * LinearSearchByID RPC is the method to linear search similar vectors using a user-defined vector ID.
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by ID. * * @generated from protobuf rpc: LinearSearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response); */ @@ -332,32 +130,7 @@ class SearchClient extends grpc.Client { return this.makeUnaryRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * StreamLinearSearch RPC is the method to linear search vectors with multi queries(vectors) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple vectors. * * @generated from protobuf rpc: StreamLinearSearch(stream payload.v1.Search.Request) returns (stream payload.v1.Search.StreamResponse); */ @@ -366,32 +139,7 @@ class SearchClient extends grpc.Client { return this.makeBidiStreamRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * Overview - * StreamLinearSearchByID RPC is the method to linear search vectors with multi queries(IDs) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * 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. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple IDs. * * @generated from protobuf rpc: StreamLinearSearchByID(stream payload.v1.Search.IDRequest) returns (stream payload.v1.Search.StreamResponse); */ @@ -400,35 +148,8 @@ class SearchClient extends grpc.Client { return this.makeBidiStreamRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple vectors in a single + * request. * * @generated from protobuf rpc: MultiLinearSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses); */ @@ -437,35 +158,8 @@ class SearchClient extends grpc.Client { return this.makeUnaryRequest(`/${search_pb_1.Search.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * 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. - *
- * // --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | 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. | - * | NOT_FOUND | The Requested ID is not inserted on the target Vald cluster, or the search result is insufficient to the required result length. | Send a request with another vector or set min_num to a smaller value. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to linear search indexed vectors by multiple IDs in a single + * request. * * @generated from protobuf rpc: MultiLinearSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses); */ diff --git a/src/vald/v1/vald/update_pb.grpc-client.d.ts b/src/vald/v1/vald/update_pb.grpc-client.d.ts index 67b2381..83f8e36 100644 --- a/src/vald/v1/vald/update_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/update_pb.grpc-client.d.ts @@ -30,39 +30,13 @@ import type { Object_Location } from "../payload/payload_pb"; import type { Update_Request } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Overview - * Update Service updates to new vector from inserted vector in the `vald-agent` components. + * Update service provides ways to update indexed vectors. * * @generated from protobuf service vald.v1.Update */ export interface IUpdateClient { /** - * Overview - * Update RPC is the method to update a single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to update an indexed vector. * * @generated from protobuf rpc: Update(payload.v1.Update.Request) returns (payload.v1.Object.Location); */ @@ -71,72 +45,14 @@ export interface IUpdateClient { update(input: Update_Request, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; update(input: Update_Request, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; /** - * Overview - * StreamUpdate RPC is the method to update multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * Using the bidirectional streaming RPC, the update request can be communicated in any order between client and server. - * Each Update request and response are independent. - * It's the recommended method to update the large amount of vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to update multiple indexed vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamUpdate(stream payload.v1.Update.Request) returns (stream payload.v1.Object.StreamLocation); */ streamUpdate(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamUpdate(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to update multiple indexed vectors in a single request. * * @generated from protobuf rpc: MultiUpdate(payload.v1.Update.MultiRequest) returns (payload.v1.Object.Locations); */ @@ -145,14 +61,7 @@ export interface IUpdateClient { multiUpdate(input: Update_MultiRequest, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; multiUpdate(input: Update_MultiRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; /** - * Overview * A method to update timestamp an indexed vector. - * --- - * Status Code - * TODO - * --- - * Troubleshooting - * TODO * * @generated from protobuf rpc: UpdateTimestamp(payload.v1.Update.TimestampRequest) returns (payload.v1.Object.Location); */ @@ -162,8 +71,7 @@ export interface IUpdateClient { updateTimestamp(input: Update_TimestampRequest, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; } /** - * Overview - * Update Service updates to new vector from inserted vector in the `vald-agent` components. + * Update service provides ways to update indexed vectors. * * @generated from protobuf service vald.v1.Update */ @@ -171,115 +79,25 @@ export declare class UpdateClient extends grpc.Client implements IUpdateClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * Overview - * Update RPC is the method to update a single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to update an indexed vector. * * @generated from protobuf rpc: Update(payload.v1.Update.Request) returns (payload.v1.Object.Location); */ update(input: Update_Request, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Location) => void)): grpc.ClientUnaryCall; /** - * Overview - * StreamUpdate RPC is the method to update multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * Using the bidirectional streaming RPC, the update request can be communicated in any order between client and server. - * Each Update request and response are independent. - * It's the recommended method to update the large amount of vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to update multiple indexed vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamUpdate(stream payload.v1.Update.Request) returns (stream payload.v1.Object.StreamLocation); */ streamUpdate(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to update multiple indexed vectors in a single request. * * @generated from protobuf rpc: MultiUpdate(payload.v1.Update.MultiRequest) returns (payload.v1.Object.Locations); */ multiUpdate(input: Update_MultiRequest, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Locations) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Locations) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Locations) => void)): grpc.ClientUnaryCall; /** - * Overview * A method to update timestamp an indexed vector. - * --- - * Status Code - * TODO - * --- - * Troubleshooting - * TODO * * @generated from protobuf rpc: UpdateTimestamp(payload.v1.Update.TimestampRequest) returns (payload.v1.Object.Location); */ diff --git a/src/vald/v1/vald/update_pb.grpc-client.js b/src/vald/v1/vald/update_pb.grpc-client.js index 8461fc9..9e3281f 100644 --- a/src/vald/v1/vald/update_pb.grpc-client.js +++ b/src/vald/v1/vald/update_pb.grpc-client.js @@ -48,8 +48,7 @@ exports.UpdateClient = void 0; const update_pb_1 = require("./update_pb"); const grpc = require("@grpc/grpc-js"); /** - * Overview - * Update Service updates to new vector from inserted vector in the `vald-agent` components. + * Update service provides ways to update indexed vectors. * * @generated from protobuf service vald.v1.Update */ @@ -59,32 +58,7 @@ class UpdateClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * Overview - * Update RPC is the method to update a single vector. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to update an indexed vector. * * @generated from protobuf rpc: Update(payload.v1.Update.Request) returns (payload.v1.Object.Location); */ @@ -93,35 +67,7 @@ class UpdateClient extends grpc.Client { return this.makeUnaryRequest(`/${update_pb_1.Update.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * StreamUpdate RPC is the method to update multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * Using the bidirectional streaming RPC, the update request can be communicated in any order between client and server. - * Each Update request and response are independent. - * It's the recommended method to update the large amount of vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to update multiple indexed vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamUpdate(stream payload.v1.Update.Request) returns (stream payload.v1.Object.StreamLocation); */ @@ -130,37 +76,7 @@ class UpdateClient extends grpc.Client { return this.makeBidiStreamRequest(`/${update_pb_1.Update.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | NOT_FOUND | Requested ID is NOT inserted. | Send a request with an ID that is already inserted. | - * | ALREADY_EXISTS | Request pair of ID and vector is already inserted. | Change request ID. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to update multiple indexed vectors in a single request. * * @generated from protobuf rpc: MultiUpdate(payload.v1.Update.MultiRequest) returns (payload.v1.Object.Locations); */ @@ -169,14 +85,7 @@ class UpdateClient extends grpc.Client { return this.makeUnaryRequest(`/${update_pb_1.Update.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview * A method to update timestamp an indexed vector. - * --- - * Status Code - * TODO - * --- - * Troubleshooting - * TODO * * @generated from protobuf rpc: UpdateTimestamp(payload.v1.Update.TimestampRequest) returns (payload.v1.Object.Location); */ diff --git a/src/vald/v1/vald/upsert_pb.grpc-client.d.ts b/src/vald/v1/vald/upsert_pb.grpc-client.d.ts index 176bdf0..75fa756 100644 --- a/src/vald/v1/vald/upsert_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/upsert_pb.grpc-client.d.ts @@ -29,38 +29,13 @@ import type { Object_Location } from "../payload/payload_pb"; import type { Upsert_Request } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Overview - * Upsert Service is responsible for updating existing vectors in the `vald-agent` or inserting new vectors into the `vald-agent` if the vector does not exist. + * Upsert service provides ways to insert/update vectors. * * @generated from protobuf service vald.v1.Upsert */ export interface IUpsertClient { /** - * Overview - * Upsert RPC is the method to update the inserted vector to a new single vector or add a new single vector if not inserted before. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to insert/update a vector. * * @generated from protobuf rpc: Upsert(payload.v1.Upsert.Request) returns (payload.v1.Object.Location); */ @@ -69,70 +44,14 @@ export interface IUpsertClient { upsert(input: Upsert_Request, options: grpc.CallOptions, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; upsert(input: Upsert_Request, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; /** - * Overview - * StreamUpsert RPC is the method to update multiple existing vectors or add new multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * Using the bidirectional streaming RPC, the upsert request can be communicated in any order between the client and server. - * Each Upsert request and response are independent. - * It’s the recommended method to upsert a large number of vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to insert/update multiple vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamUpsert(stream payload.v1.Upsert.Request) returns (stream payload.v1.Object.StreamLocation); */ streamUpsert(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream; streamUpsert(options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to insert/update multiple vectors in a single request. * * @generated from protobuf rpc: MultiUpsert(payload.v1.Upsert.MultiRequest) returns (payload.v1.Object.Locations); */ @@ -142,8 +61,7 @@ export interface IUpsertClient { multiUpsert(input: Upsert_MultiRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; } /** - * Overview - * Upsert Service is responsible for updating existing vectors in the `vald-agent` or inserting new vectors into the `vald-agent` if the vector does not exist. + * Upsert service provides ways to insert/update vectors. * * @generated from protobuf service vald.v1.Upsert */ @@ -151,99 +69,19 @@ export declare class UpsertClient extends grpc.Client implements IUpsertClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * Overview - * Upsert RPC is the method to update the inserted vector to a new single vector or add a new single vector if not inserted before. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to insert/update a vector. * * @generated from protobuf rpc: Upsert(payload.v1.Upsert.Request) returns (payload.v1.Object.Location); */ upsert(input: Upsert_Request, metadata: grpc.Metadata | grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), options?: grpc.CallOptions | ((err: grpc.ServiceError | null, value?: Object_Location) => void), callback?: ((err: grpc.ServiceError | null, value?: Object_Location) => void)): grpc.ClientUnaryCall; /** - * Overview - * StreamUpsert RPC is the method to update multiple existing vectors or add new multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * Using the bidirectional streaming RPC, the upsert request can be communicated in any order between the client and server. - * Each Upsert request and response are independent. - * It’s the recommended method to upsert a large number of vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to insert/update multiple vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamUpsert(stream payload.v1.Upsert.Request) returns (stream payload.v1.Object.StreamLocation); */ streamUpsert(metadata?: grpc.Metadata | grpc.CallOptions, options?: grpc.CallOptions): grpc.ClientDuplexStream; /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to insert/update multiple vectors in a single request. * * @generated from protobuf rpc: MultiUpsert(payload.v1.Upsert.MultiRequest) returns (payload.v1.Object.Locations); */ diff --git a/src/vald/v1/vald/upsert_pb.grpc-client.js b/src/vald/v1/vald/upsert_pb.grpc-client.js index 8d82465..c86b22b 100644 --- a/src/vald/v1/vald/upsert_pb.grpc-client.js +++ b/src/vald/v1/vald/upsert_pb.grpc-client.js @@ -48,8 +48,7 @@ exports.UpsertClient = void 0; const upsert_pb_1 = require("./upsert_pb"); const grpc = require("@grpc/grpc-js"); /** - * Overview - * Upsert Service is responsible for updating existing vectors in the `vald-agent` or inserting new vectors into the `vald-agent` if the vector does not exist. + * Upsert service provides ways to insert/update vectors. * * @generated from protobuf service vald.v1.Upsert */ @@ -59,31 +58,7 @@ class UpsertClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * Overview - * Upsert RPC is the method to update the inserted vector to a new single vector or add a new single vector if not inserted before. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to insert/update a vector. * * @generated from protobuf rpc: Upsert(payload.v1.Upsert.Request) returns (payload.v1.Object.Location); */ @@ -92,34 +67,7 @@ class UpsertClient extends grpc.Client { return this.makeUnaryRequest(`/${upsert_pb_1.Upsert.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback); } /** - * Overview - * StreamUpsert RPC is the method to update multiple existing vectors or add new multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
- * Using the bidirectional streaming RPC, the upsert request can be communicated in any order between the client and server. - * Each Upsert request and response are independent. - * It’s the recommended method to upsert a large number of vectors. - * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to insert/update multiple vectors by bidirectional streaming. * * @generated from protobuf rpc: StreamUpsert(stream payload.v1.Upsert.Request) returns (stream payload.v1.Object.StreamLocation); */ @@ -128,36 +76,7 @@ class UpsertClient extends grpc.Client { return this.makeBidiStreamRequest(`/${upsert_pb_1.Upsert.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options); } /** - * 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. - *
- * --- - * Status Code - * | 0 | OK | - * | 1 | CANCELLED | - * | 3 | INVALID_ARGUMENT | - * | 4 | DEADLINE_EXCEEDED | - * | 5 | NOT_FOUND | - * | 6 | ALREADY_EXISTS | - * | 10 | ABORTED | - * | 13 | INTERNAL | - * --- - * 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. | - * | INVALID_ARGUMENT | The Dimension of the request vector is NOT the same as Vald Agent's config, the requested vector's ID is empty, 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. | - * | ALREADY_EXISTS | Requested pair of ID and vector is already inserted | Change request payload or nothing to do if update is unnecessary. | - * | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | + * A method to insert/update multiple vectors in a single request. * * @generated from protobuf rpc: MultiUpsert(payload.v1.Upsert.MultiRequest) returns (payload.v1.Object.Locations); */