diff --git a/VALD_SHA b/VALD_SHA index 56fcc97..4b04ce1 100644 --- a/VALD_SHA +++ b/VALD_SHA @@ -1 +1 @@ -d99ad22bef98ec6695eb2965de4d05cdbe37189d \ No newline at end of file +3d74ef58a8fb20444d59b65e4e40b2725812b630 \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 1f0d64d..5f4a077 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1056,6 +1056,7 @@ "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.8.tgz", "integrity": "sha512-imAbBGkb+ebQyxKgzv5Hu2nmROxoDOXHh80evxdoXNOrvAnVx7zimzc1Oo5h9RlfV4vPXaE2iM5pOFbvOCClWA==", "dev": true, + "license": "MIT", "dependencies": { "@jridgewell/set-array": "^1.2.1", "@jridgewell/sourcemap-codec": "^1.4.10", @@ -1725,7 +1726,8 @@ "type": "github", "url": "https://github.com/sponsors/ai" } - ] + ], + "license": "CC-BY-4.0" }, "node_modules/chalk": { "version": "4.1.2", @@ -1978,7 +1980,8 @@ "version": "1.5.73", "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.73.tgz", "integrity": "sha512-8wGNxG9tAG5KhGd3eeA0o6ixhiNdgr0DcHWm85XPCphwZgD1lIEoi6t3VERayWao7SF7AAZTw6oARGJeVjH8Kg==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/emittery": { "version": "0.13.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 8f13279..4c41d16 100644 --- a/src/vald/v1/vald/filter_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/filter_pb.grpc-client.d.ts @@ -38,13 +38,25 @@ import type { Search_Response } from "../payload/payload_pb"; import type { Search_ObjectRequest } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Filter service provides ways to connect to Vald through filter. + * 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. * * @generated from protobuf service vald.v1.Filter */ export interface IFilterClient { /** - * A method to search object. + * 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 | * * @generated from protobuf rpc: SearchObject(payload.v1.Search.ObjectRequest) returns (payload.v1.Search.Response); */ @@ -53,7 +65,18 @@ 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; /** - * A method to search multiple objects. + * 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 | * * @generated from protobuf rpc: MultiSearchObject(payload.v1.Search.MultiObjectRequest) returns (payload.v1.Search.Responses); */ @@ -62,14 +85,37 @@ 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; /** - * A method to search object by bidirectional streaming. + * 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 | * * @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; /** - * A method insert object. + * 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 | * * @generated from protobuf rpc: InsertObject(payload.v1.Insert.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -78,14 +124,36 @@ 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; /** - * Represent the streaming RPC to insert object by bidirectional streaming. + * 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 | * * @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; /** - * A method to insert multiple objects. + * 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 | * * @generated from protobuf rpc: MultiInsertObject(payload.v1.Insert.MultiObjectRequest) returns (payload.v1.Object.Locations); */ @@ -94,7 +162,16 @@ 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; /** - * A method to update object. + * 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 | * * @generated from protobuf rpc: UpdateObject(payload.v1.Update.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -103,14 +180,41 @@ 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; /** - * A method to update object by bidirectional streaming. + * 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 | * * @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; /** - * A method to update multiple objects. + * 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 | * * @generated from protobuf rpc: MultiUpdateObject(payload.v1.Update.MultiObjectRequest) returns (payload.v1.Object.Locations); */ @@ -119,7 +223,16 @@ 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; /** - * A method to upsert object. + * 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 | * * @generated from protobuf rpc: UpsertObject(payload.v1.Upsert.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -128,14 +241,37 @@ 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; /** - * A method to upsert object by bidirectional streaming. + * 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 | * * @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; /** - * A method to upsert multiple objects. + * 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 | * * @generated from protobuf rpc: MultiUpsertObject(payload.v1.Upsert.MultiObjectRequest) returns (payload.v1.Object.Locations); */ @@ -145,7 +281,10 @@ export interface IFilterClient { multiUpsertObject(input: Upsert_MultiObjectRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; } /** - * Filter service provides ways to connect to Vald through filter. + * 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. * * @generated from protobuf service vald.v1.Filter */ @@ -153,73 +292,206 @@ export declare class FilterClient extends grpc.Client implements IFilterClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * A method to search object. + * 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 | * * @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; /** - * A method to search multiple objects. + * 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 | * * @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; /** - * A method to search object by bidirectional streaming. + * 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 | * * @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; /** - * A method insert object. + * 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 | * * @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; /** - * Represent the streaming RPC to insert object by bidirectional streaming. + * 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 | * * @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; /** - * A method to insert multiple objects. + * 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 | * * @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; /** - * A method to update object. + * 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 | * * @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; /** - * A method to update object by bidirectional streaming. + * 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 | * * @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; /** - * A method to update multiple objects. + * 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 | * * @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; /** - * A method to upsert object. + * 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 | * * @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; /** - * A method to upsert object by bidirectional streaming. + * 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 | * * @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; /** - * A method to upsert multiple objects. + * 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 | * * @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 8c6e23f..fb27414 100644 --- a/src/vald/v1/vald/filter_pb.grpc-client.js +++ b/src/vald/v1/vald/filter_pb.grpc-client.js @@ -48,7 +48,10 @@ exports.FilterClient = void 0; const filter_pb_1 = require("./filter_pb"); const grpc = require("@grpc/grpc-js"); /** - * Filter service provides ways to connect to Vald through filter. + * 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. * * @generated from protobuf service vald.v1.Filter */ @@ -58,7 +61,16 @@ class FilterClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * A method to search object. + * 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 | * * @generated from protobuf rpc: SearchObject(payload.v1.Search.ObjectRequest) returns (payload.v1.Search.Response); */ @@ -67,7 +79,18 @@ 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); } /** - * A method to search multiple objects. + * 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 | * * @generated from protobuf rpc: MultiSearchObject(payload.v1.Search.MultiObjectRequest) returns (payload.v1.Search.Responses); */ @@ -76,7 +99,21 @@ 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); } /** - * A method to search object by bidirectional streaming. + * 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 | * * @generated from protobuf rpc: StreamSearchObject(stream payload.v1.Search.ObjectRequest) returns (stream payload.v1.Search.StreamResponse); */ @@ -85,7 +122,16 @@ 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); } /** - * A method insert object. + * 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 | * * @generated from protobuf rpc: InsertObject(payload.v1.Insert.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -94,7 +140,20 @@ 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); } /** - * Represent the streaming RPC to insert object by bidirectional streaming. + * 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 | * * @generated from protobuf rpc: StreamInsertObject(stream payload.v1.Insert.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ @@ -103,7 +162,16 @@ 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); } /** - * A method to insert multiple objects. + * 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 | * * @generated from protobuf rpc: MultiInsertObject(payload.v1.Insert.MultiObjectRequest) returns (payload.v1.Object.Locations); */ @@ -112,7 +180,16 @@ 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); } /** - * A method to update object. + * 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 | * * @generated from protobuf rpc: UpdateObject(payload.v1.Update.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -121,7 +198,19 @@ 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); } /** - * A method to update object by bidirectional streaming. + * 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 | * * @generated from protobuf rpc: StreamUpdateObject(stream payload.v1.Update.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ @@ -130,7 +219,22 @@ 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); } /** - * A method to update multiple objects. + * 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 | * * @generated from protobuf rpc: MultiUpdateObject(payload.v1.Update.MultiObjectRequest) returns (payload.v1.Object.Locations); */ @@ -139,7 +243,16 @@ 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); } /** - * A method to upsert object. + * 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 | * * @generated from protobuf rpc: UpsertObject(payload.v1.Upsert.ObjectRequest) returns (payload.v1.Object.Location); */ @@ -148,7 +261,16 @@ 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); } /** - * A method to upsert object by bidirectional streaming. + * 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 | * * @generated from protobuf rpc: StreamUpsertObject(stream payload.v1.Upsert.ObjectRequest) returns (stream payload.v1.Object.StreamLocation); */ @@ -157,7 +279,21 @@ 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); } /** - * A method to upsert multiple objects. + * 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 | * * @generated from protobuf rpc: MultiUpsertObject(payload.v1.Upsert.MultiObjectRequest) returns (payload.v1.Object.Locations); */ 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 1e7c248..b984081 100644 --- a/src/vald/v1/vald/index_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/index_pb.grpc-client.d.ts @@ -30,12 +30,14 @@ 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); @@ -45,6 +47,7 @@ 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); @@ -54,6 +57,7 @@ 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); @@ -63,6 +67,7 @@ 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); @@ -72,6 +77,7 @@ 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); @@ -82,6 +88,7 @@ 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 @@ -90,30 +97,35 @@ 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 4e426a3..ad25962 100644 --- a/src/vald/v1/vald/index_pb.grpc-client.js +++ b/src/vald/v1/vald/index_pb.grpc-client.js @@ -48,6 +48,7 @@ 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 @@ -58,6 +59,7 @@ 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); @@ -67,6 +69,7 @@ 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); @@ -76,6 +79,7 @@ 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); @@ -85,6 +89,7 @@ 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); @@ -94,6 +99,7 @@ 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 e9572cd..7f0c63b 100644 --- a/src/vald/v1/vald/insert_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/insert_pb.grpc-client.d.ts @@ -29,13 +29,36 @@ import type { Object_Location } from "../payload/payload_pb"; import type { Insert_Request } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Insert service provides ways to add new vectors. + * Overview + * Insert Service is responsible for inserting new vectors into the `vald-agent`. * * @generated from protobuf service vald.v1.Insert */ export interface IInsertClient { /** - * A method to add a new single vector. + * 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. | * * @generated from protobuf rpc: Insert(payload.v1.Insert.Request) returns (payload.v1.Object.Location); */ @@ -44,14 +67,68 @@ 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; /** - * A method to add new multiple vectors by bidirectional streaming. + * 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. | * * @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; /** - * A method to add new multiple vectors in a single request. + * 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. | * * @generated from protobuf rpc: MultiInsert(payload.v1.Insert.MultiRequest) returns (payload.v1.Object.Locations); */ @@ -61,7 +138,8 @@ export interface IInsertClient { multiInsert(input: Insert_MultiRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; } /** - * Insert service provides ways to add new vectors. + * Overview + * Insert Service is responsible for inserting new vectors into the `vald-agent`. * * @generated from protobuf service vald.v1.Insert */ @@ -69,19 +147,95 @@ export declare class InsertClient extends grpc.Client implements IInsertClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * A method to add a new single vector. + * 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. | * * @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; /** - * A method to add new multiple vectors by bidirectional streaming. + * 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. | * * @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; /** - * A method to add new multiple vectors in a single request. + * 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. | * * @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 a408f12..f231cd8 100644 --- a/src/vald/v1/vald/insert_pb.grpc-client.js +++ b/src/vald/v1/vald/insert_pb.grpc-client.js @@ -48,7 +48,8 @@ exports.InsertClient = void 0; const insert_pb_1 = require("./insert_pb"); const grpc = require("@grpc/grpc-js"); /** - * Insert service provides ways to add new vectors. + * Overview + * Insert Service is responsible for inserting new vectors into the `vald-agent`. * * @generated from protobuf service vald.v1.Insert */ @@ -58,7 +59,29 @@ class InsertClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * A method to add a new single vector. + * 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. | * * @generated from protobuf rpc: Insert(payload.v1.Insert.Request) returns (payload.v1.Object.Location); */ @@ -67,7 +90,33 @@ 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); } /** - * A method to add new multiple vectors by bidirectional streaming. + * 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. | * * @generated from protobuf rpc: StreamInsert(stream payload.v1.Insert.Request) returns (stream payload.v1.Object.StreamLocation); */ @@ -76,7 +125,35 @@ 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); } /** - * A method to add new multiple vectors in a single request. + * 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. | * * @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 51bede0..14edc1d 100644 --- a/src/vald/v1/vald/object_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/object_pb.grpc-client.d.ts @@ -32,13 +32,36 @@ import type { Object_VectorRequest } from "../payload/payload_pb"; import type { Object_ID } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Object service provides ways to fetch indexed vectors. + * Overview + * Object Service is responsible for getting inserted vectors and checking whether vectors are inserted into the `vald-agent`. * * @generated from protobuf service vald.v1.Object */ export interface IObjectClient { /** - * A method to check whether a specified ID is indexed or not. + * 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. | * * @generated from protobuf rpc: Exists(payload.v1.Object.ID) returns (payload.v1.Object.ID); */ @@ -47,7 +70,29 @@ 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; /** - * A method to fetch a vector. + * 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. | * * @generated from protobuf rpc: GetObject(payload.v1.Object.VectorRequest) returns (payload.v1.Object.Vector); */ @@ -56,21 +101,59 @@ 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; /** - * A method to fetch vectors by bidirectional streaming. + * 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. | * * @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); */ @@ -80,7 +163,8 @@ export interface IObjectClient { getTimestamp(input: Object_TimestampRequest, callback: (err: grpc.ServiceError | null, value?: Object_Timestamp) => void): grpc.ClientUnaryCall; } /** - * Object service provides ways to fetch indexed vectors. + * Overview + * Object Service is responsible for getting inserted vectors and checking whether vectors are inserted into the `vald-agent`. * * @generated from protobuf service vald.v1.Object */ @@ -88,31 +172,113 @@ export declare class ObjectClient extends grpc.Client implements IObjectClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * A method to check whether a specified ID is indexed or not. + * 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. | * * @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; /** - * A method to fetch a vector. + * 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. | * * @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; /** - * A method to fetch vectors by bidirectional streaming. + * 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. | * * @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 d9bc2a5..4a7469d 100644 --- a/src/vald/v1/vald/object_pb.grpc-client.js +++ b/src/vald/v1/vald/object_pb.grpc-client.js @@ -48,7 +48,8 @@ exports.ObjectClient = void 0; const object_pb_1 = require("./object_pb"); const grpc = require("@grpc/grpc-js"); /** - * Object service provides ways to fetch indexed vectors. + * Overview + * Object Service is responsible for getting inserted vectors and checking whether vectors are inserted into the `vald-agent`. * * @generated from protobuf service vald.v1.Object */ @@ -58,7 +59,29 @@ class ObjectClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * A method to check whether a specified ID is indexed or not. + * 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. | * * @generated from protobuf rpc: Exists(payload.v1.Object.ID) returns (payload.v1.Object.ID); */ @@ -67,7 +90,29 @@ 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); } /** - * A method to fetch a vector. + * 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. | * * @generated from protobuf rpc: GetObject(payload.v1.Object.VectorRequest) returns (payload.v1.Object.Vector); */ @@ -76,7 +121,31 @@ 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); } /** - * A method to fetch vectors by bidirectional streaming. + * 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. | * * @generated from protobuf rpc: StreamGetObject(stream payload.v1.Object.VectorRequest) returns (stream payload.v1.Object.StreamVector); */ @@ -85,7 +154,14 @@ 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); */ @@ -94,7 +170,14 @@ 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 60bc939..302c419 100644 --- a/src/vald/v1/vald/remove_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/remove_pb.grpc-client.d.ts @@ -30,13 +30,37 @@ import type { Object_Location } from "../payload/payload_pb"; import type { Remove_Request } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Remove service provides ways to remove indexed vectors. + * Overview + * Remove Service is responsible for removing vectors indexed in the `vald-agent`. * * @generated from protobuf service vald.v1.Remove */ export interface IRemoveClient { /** - * A method to remove an indexed vector. + * 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. | * * @generated from protobuf rpc: Remove(payload.v1.Remove.Request) returns (payload.v1.Object.Location); */ @@ -45,7 +69,33 @@ 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; /** - * A method to remove an indexed vector based on timestamp. + * 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. * * @generated from protobuf rpc: RemoveByTimestamp(payload.v1.Remove.TimestampRequest) returns (payload.v1.Object.Locations); */ @@ -54,14 +104,70 @@ 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; /** - * A method to remove multiple indexed vectors in a single request. + * 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. | * * @generated from protobuf rpc: MultiRemove(payload.v1.Remove.MultiRequest) returns (payload.v1.Object.Locations); */ @@ -71,7 +177,8 @@ export interface IRemoveClient { multiRemove(input: Remove_MultiRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; } /** - * Remove service provides ways to remove indexed vectors. + * Overview + * Remove Service is responsible for removing vectors indexed in the `vald-agent`. * * @generated from protobuf service vald.v1.Remove */ @@ -79,25 +186,130 @@ export declare class RemoveClient extends grpc.Client implements IRemoveClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * A method to remove an indexed vector. + * 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. | * * @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; /** - * A method to remove an indexed vector based on timestamp. + * 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. * * @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; /** - * A method to remove multiple indexed vectors in a single request. + * 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. | * * @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 11780a2..bd6c943 100644 --- a/src/vald/v1/vald/remove_pb.grpc-client.js +++ b/src/vald/v1/vald/remove_pb.grpc-client.js @@ -48,7 +48,8 @@ exports.RemoveClient = void 0; const remove_pb_1 = require("./remove_pb"); const grpc = require("@grpc/grpc-js"); /** - * Remove service provides ways to remove indexed vectors. + * Overview + * Remove Service is responsible for removing vectors indexed in the `vald-agent`. * * @generated from protobuf service vald.v1.Remove */ @@ -58,7 +59,30 @@ class RemoveClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * A method to remove an indexed vector. + * 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. | * * @generated from protobuf rpc: Remove(payload.v1.Remove.Request) returns (payload.v1.Object.Location); */ @@ -67,7 +91,33 @@ 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); } /** - * A method to remove an indexed vector based on timestamp. + * 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. * * @generated from protobuf rpc: RemoveByTimestamp(payload.v1.Remove.TimestampRequest) returns (payload.v1.Object.Locations); */ @@ -76,8 +126,36 @@ 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) { @@ -85,7 +163,35 @@ 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); } /** - * A method to remove multiple indexed vectors in a single request. + * 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. | * * @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 e0f2eef..296a7c3 100644 --- a/src/vald/v1/vald/search_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/search_pb.grpc-client.d.ts @@ -31,13 +31,37 @@ import type { Search_Response } from "../payload/payload_pb"; import type { Search_Request } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Search service provides ways to search indexed vectors. + * Overview + * Search Service is responsible for searching vectors similar to the user request vector from `vald-agent`. * * @generated from protobuf service vald.v1.Search */ export interface ISearchClient { /** - * A method to search indexed vectors by a raw vector. + * 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. | * * @generated from protobuf rpc: Search(payload.v1.Search.Request) returns (payload.v1.Search.Response); */ @@ -46,7 +70,31 @@ 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; /** - * A method to search indexed vectors by ID. + * 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. | * * @generated from protobuf rpc: SearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response); */ @@ -55,21 +103,99 @@ 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; /** - * A method to search indexed vectors by multiple vectors. + * 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. | * * @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; /** - * A method to search indexed vectors by multiple IDs. + * 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. | * * @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; /** - * A method to search indexed vectors by multiple vectors in a single request. + * 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. | * * @generated from protobuf rpc: MultiSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses); */ @@ -78,7 +204,35 @@ 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; /** - * A method to search indexed vectors by multiple IDs in a single request. + * 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. | * * @generated from protobuf rpc: MultiSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses); */ @@ -87,7 +241,30 @@ 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; /** - * A method to linear search indexed vectors by a raw vector. + * 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. | * * @generated from protobuf rpc: LinearSearch(payload.v1.Search.Request) returns (payload.v1.Search.Response); */ @@ -96,7 +273,32 @@ 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; /** - * A method to linear search indexed vectors by ID. + * 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. | * * @generated from protobuf rpc: LinearSearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response); */ @@ -105,22 +307,99 @@ 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; /** - * A method to linear search indexed vectors by multiple vectors. + * 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. | * * @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; /** - * A method to linear search indexed vectors by multiple IDs. + * 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. | * * @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; /** - * A method to linear search indexed vectors by multiple vectors in a single - * request. + * 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. | * * @generated from protobuf rpc: MultiLinearSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses); */ @@ -129,8 +408,35 @@ 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; /** - * A method to linear search indexed vectors by multiple IDs in a single - * request. + * 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. | * * @generated from protobuf rpc: MultiLinearSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses); */ @@ -140,7 +446,8 @@ export interface ISearchClient { multiLinearSearchByID(input: Search_MultiIDRequest, callback: (err: grpc.ServiceError | null, value?: Search_Responses) => void): grpc.ClientUnaryCall; } /** - * Search service provides ways to search indexed vectors. + * Overview + * Search Service is responsible for searching vectors similar to the user request vector from `vald-agent`. * * @generated from protobuf service vald.v1.Search */ @@ -148,75 +455,380 @@ export declare class SearchClient extends grpc.Client implements ISearchClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * A method to search indexed vectors by a raw vector. + * 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. | * * @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; /** - * A method to search indexed vectors by ID. + * 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. | * * @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; /** - * A method to search indexed vectors by multiple vectors. + * 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. | * * @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; /** - * A method to search indexed vectors by multiple IDs. + * 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. | * * @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; /** - * A method to search indexed vectors by multiple vectors in a single request. + * 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. | * * @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; /** - * A method to search indexed vectors by multiple IDs in a single request. + * 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. | * * @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; /** - * A method to linear search indexed vectors by a raw vector. + * 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. | * * @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; /** - * A method to linear search indexed vectors by ID. + * 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. | * * @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; /** - * A method to linear search indexed vectors by multiple vectors. + * 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. | * * @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; /** - * A method to linear search indexed vectors by multiple IDs. + * 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. | * * @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; /** - * A method to linear search indexed vectors by multiple vectors in a single - * request. + * 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. | * * @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; /** - * A method to linear search indexed vectors by multiple IDs in a single - * request. + * 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. | * * @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 56197c4..0f8985b 100644 --- a/src/vald/v1/vald/search_pb.grpc-client.js +++ b/src/vald/v1/vald/search_pb.grpc-client.js @@ -48,7 +48,8 @@ exports.SearchClient = void 0; const search_pb_1 = require("./search_pb"); const grpc = require("@grpc/grpc-js"); /** - * Search service provides ways to search indexed vectors. + * Overview + * Search Service is responsible for searching vectors similar to the user request vector from `vald-agent`. * * @generated from protobuf service vald.v1.Search */ @@ -58,7 +59,30 @@ class SearchClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * A method to search indexed vectors by a raw vector. + * 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. | * * @generated from protobuf rpc: Search(payload.v1.Search.Request) returns (payload.v1.Search.Response); */ @@ -67,7 +91,31 @@ 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); } /** - * A method to search indexed vectors by ID. + * 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. | * * @generated from protobuf rpc: SearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response); */ @@ -76,7 +124,32 @@ 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); } /** - * A method to search indexed vectors by multiple vectors. + * 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. | * * @generated from protobuf rpc: StreamSearch(stream payload.v1.Search.Request) returns (stream payload.v1.Search.StreamResponse); */ @@ -85,7 +158,32 @@ 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); } /** - * A method to search indexed vectors by multiple IDs. + * 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. | * * @generated from protobuf rpc: StreamSearchByID(stream payload.v1.Search.IDRequest) returns (stream payload.v1.Search.StreamResponse); */ @@ -94,7 +192,35 @@ 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); } /** - * A method to search indexed vectors by multiple vectors in a single request. + * 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. | * * @generated from protobuf rpc: MultiSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses); */ @@ -103,7 +229,35 @@ 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); } /** - * A method to search indexed vectors by multiple IDs in a single request. + * 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. | * * @generated from protobuf rpc: MultiSearchByID(payload.v1.Search.MultiIDRequest) returns (payload.v1.Search.Responses); */ @@ -112,7 +266,30 @@ 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); } /** - * A method to linear search indexed vectors by a raw vector. + * 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. | * * @generated from protobuf rpc: LinearSearch(payload.v1.Search.Request) returns (payload.v1.Search.Response); */ @@ -121,7 +298,32 @@ 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); } /** - * A method to linear search indexed vectors by ID. + * 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. | * * @generated from protobuf rpc: LinearSearchByID(payload.v1.Search.IDRequest) returns (payload.v1.Search.Response); */ @@ -130,7 +332,32 @@ 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); } /** - * A method to linear search indexed vectors by multiple vectors. + * 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. | * * @generated from protobuf rpc: StreamLinearSearch(stream payload.v1.Search.Request) returns (stream payload.v1.Search.StreamResponse); */ @@ -139,7 +366,32 @@ 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); } /** - * A method to linear search indexed vectors by multiple IDs. + * 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. | * * @generated from protobuf rpc: StreamLinearSearchByID(stream payload.v1.Search.IDRequest) returns (stream payload.v1.Search.StreamResponse); */ @@ -148,8 +400,35 @@ 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); } /** - * A method to linear search indexed vectors by multiple vectors in a single - * request. + * 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. | * * @generated from protobuf rpc: MultiLinearSearch(payload.v1.Search.MultiRequest) returns (payload.v1.Search.Responses); */ @@ -158,8 +437,35 @@ 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); } /** - * A method to linear search indexed vectors by multiple IDs in a single - * request. + * 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. | * * @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 83f8e36..67b2381 100644 --- a/src/vald/v1/vald/update_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/update_pb.grpc-client.d.ts @@ -30,13 +30,39 @@ import type { Object_Location } from "../payload/payload_pb"; import type { Update_Request } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Update service provides ways to update indexed vectors. + * Overview + * Update Service updates to new vector from inserted vector in the `vald-agent` components. * * @generated from protobuf service vald.v1.Update */ export interface IUpdateClient { /** - * A method to update an indexed vector. + * 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. | * * @generated from protobuf rpc: Update(payload.v1.Update.Request) returns (payload.v1.Object.Location); */ @@ -45,14 +71,72 @@ 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; /** - * A method to update multiple indexed vectors by bidirectional streaming. + * 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. | * * @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; /** - * A method to update multiple indexed vectors in a single request. + * 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. | * * @generated from protobuf rpc: MultiUpdate(payload.v1.Update.MultiRequest) returns (payload.v1.Object.Locations); */ @@ -61,7 +145,14 @@ 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); */ @@ -71,7 +162,8 @@ export interface IUpdateClient { updateTimestamp(input: Update_TimestampRequest, callback: (err: grpc.ServiceError | null, value?: Object_Location) => void): grpc.ClientUnaryCall; } /** - * Update service provides ways to update indexed vectors. + * Overview + * Update Service updates to new vector from inserted vector in the `vald-agent` components. * * @generated from protobuf service vald.v1.Update */ @@ -79,25 +171,115 @@ export declare class UpdateClient extends grpc.Client implements IUpdateClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * A method to update an indexed vector. + * 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. | * * @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; /** - * A method to update multiple indexed vectors by bidirectional streaming. + * 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. | * * @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; /** - * A method to update multiple indexed vectors in a single request. + * 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. | * * @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 9e3281f..8461fc9 100644 --- a/src/vald/v1/vald/update_pb.grpc-client.js +++ b/src/vald/v1/vald/update_pb.grpc-client.js @@ -48,7 +48,8 @@ exports.UpdateClient = void 0; const update_pb_1 = require("./update_pb"); const grpc = require("@grpc/grpc-js"); /** - * Update service provides ways to update indexed vectors. + * Overview + * Update Service updates to new vector from inserted vector in the `vald-agent` components. * * @generated from protobuf service vald.v1.Update */ @@ -58,7 +59,32 @@ class UpdateClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * A method to update an indexed vector. + * 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. | * * @generated from protobuf rpc: Update(payload.v1.Update.Request) returns (payload.v1.Object.Location); */ @@ -67,7 +93,35 @@ 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); } /** - * A method to update multiple indexed vectors by bidirectional streaming. + * 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. | * * @generated from protobuf rpc: StreamUpdate(stream payload.v1.Update.Request) returns (stream payload.v1.Object.StreamLocation); */ @@ -76,7 +130,37 @@ 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); } /** - * A method to update multiple indexed vectors in a single request. + * 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. | * * @generated from protobuf rpc: MultiUpdate(payload.v1.Update.MultiRequest) returns (payload.v1.Object.Locations); */ @@ -85,7 +169,14 @@ 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 75fa756..176bdf0 100644 --- a/src/vald/v1/vald/upsert_pb.grpc-client.d.ts +++ b/src/vald/v1/vald/upsert_pb.grpc-client.d.ts @@ -29,13 +29,38 @@ import type { Object_Location } from "../payload/payload_pb"; import type { Upsert_Request } from "../payload/payload_pb"; import * as grpc from "@grpc/grpc-js"; /** - * Upsert service provides ways to insert/update vectors. + * 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. * * @generated from protobuf service vald.v1.Upsert */ export interface IUpsertClient { /** - * A method to insert/update a vector. + * 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. | * * @generated from protobuf rpc: Upsert(payload.v1.Upsert.Request) returns (payload.v1.Object.Location); */ @@ -44,14 +69,70 @@ 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; /** - * A method to insert/update multiple vectors by bidirectional streaming. + * 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. | * * @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; /** - * A method to insert/update multiple vectors in a single request. + * 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. | * * @generated from protobuf rpc: MultiUpsert(payload.v1.Upsert.MultiRequest) returns (payload.v1.Object.Locations); */ @@ -61,7 +142,8 @@ export interface IUpsertClient { multiUpsert(input: Upsert_MultiRequest, callback: (err: grpc.ServiceError | null, value?: Object_Locations) => void): grpc.ClientUnaryCall; } /** - * Upsert service provides ways to insert/update vectors. + * 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. * * @generated from protobuf service vald.v1.Upsert */ @@ -69,19 +151,99 @@ export declare class UpsertClient extends grpc.Client implements IUpsertClient { private readonly _binaryOptions; constructor(address: string, credentials: grpc.ChannelCredentials, options?: grpc.ClientOptions, binaryOptions?: Partial); /** - * A method to insert/update a vector. + * 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. | * * @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; /** - * A method to insert/update multiple vectors by bidirectional streaming. + * 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. | * * @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; /** - * A method to insert/update multiple vectors in a single request. + * 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. | * * @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 c86b22b..8d82465 100644 --- a/src/vald/v1/vald/upsert_pb.grpc-client.js +++ b/src/vald/v1/vald/upsert_pb.grpc-client.js @@ -48,7 +48,8 @@ exports.UpsertClient = void 0; const upsert_pb_1 = require("./upsert_pb"); const grpc = require("@grpc/grpc-js"); /** - * Upsert service provides ways to insert/update vectors. + * 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. * * @generated from protobuf service vald.v1.Upsert */ @@ -58,7 +59,31 @@ class UpsertClient extends grpc.Client { this._binaryOptions = binaryOptions; } /** - * A method to insert/update a vector. + * 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. | * * @generated from protobuf rpc: Upsert(payload.v1.Upsert.Request) returns (payload.v1.Object.Location); */ @@ -67,7 +92,34 @@ 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); } /** - * A method to insert/update multiple vectors by bidirectional streaming. + * 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. | * * @generated from protobuf rpc: StreamUpsert(stream payload.v1.Upsert.Request) returns (stream payload.v1.Object.StreamLocation); */ @@ -76,7 +128,36 @@ 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); } /** - * A method to insert/update multiple vectors in a single request. + * 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. | * * @generated from protobuf rpc: MultiUpsert(payload.v1.Upsert.MultiRequest) returns (payload.v1.Object.Locations); */