Update [vald sha: 3d74ef58a8fb20444d59b65e4e40b2725812b630]

Signed-off-by: Vdaas CI <[email protected]>
vdaas · Dec 13, 2024 · 08e8498 · 08e8498
1 parent 4bc92fe
commit 08e8498
Show file tree

Hide file tree

Showing 18 changed files with 2,808 additions and 147 deletions.
diff --git a/VALD_SHA b/VALD_SHA
@@ -1 +1 @@
-d99ad22bef98ec6695eb2965de4d05cdbe37189d
+3d74ef58a8fb20444d59b65e4e40b2725812b630
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/vald/v1/vald/filter_pb.grpc-client.d.ts b/src/vald/v1/vald/filter_pb.grpc-client.d.ts
diff --git 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).<br>
+     * 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.
+     *
+     * <div class="notice">
+     * gRPC has a message size limitation.<br>
+     * Please be careful that the size of the request exceeds the limit.
+     * </div>
+     * ---
+     * 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).<br>
+     * 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.
+     *
+     * <div class="notice">
+     * gRPC has the message size limitation.<br>
+     * Please be careful that the size of the request exceed the limit.
+     * </div>
+     * ---
+     * 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.
+     *
+     * <div class="notice">
+     * gRPC has a message size limitation.<br>
+     * Please be careful that the size of the request exceeds the limit.
+     * </div>
+     * ---
+     * 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
@@ -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<BinaryReadOptions & BinaryWriteOptions>);
     /**
+     * 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);
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		d99ad22bef98ec6695eb2965de4d05cdbe37189d
		3d74ef58a8fb20444d59b65e4e40b2725812b630