vald-client-python 1.7.14__tar.gz → 1.7.16__tar.gz

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/LICENSE

@@ -186,10 +186,10 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (C) 2019-2020 Vdaas.org Vald team ( kpango, rinx, kmrmt )
+   Copyright (C) 2019-2024 vdaas.org vald team <vald@vdaas.org>
 
    Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
+   You may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
        https://www.apache.org/licenses/LICENSE-2.0

{vald-client-python-1.7.14/src/vald_client_python.egg-info → vald-client-python-1.7.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vald-client-python
-Version: 1.7.14
+Version: 1.7.16
 Summary: a client library for Vald (https://github.com/vdaas/vald).
 Home-page: https://github.com/vdaas/vald-client-python
 Author: vald team

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = vald-client-python
-version = 1.7.14
+version = 1.7.16
 url = https://github.com/vdaas/vald-client-python
 description = a client library for Vald (https://github.com/vdaas/vald).
 long_description = file: README.md

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/buf/validate/expression_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: buf/validate/expression.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'buf/validate/expression.proto'

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/buf/validate/priv/private_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: buf/validate/priv/private.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'buf/validate/priv/private.proto'

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/buf/validate/validate_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: buf/validate/validate.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'buf/validate/validate.proto'

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/google/api/annotations_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: google/api/annotations.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'google/api/annotations.proto'

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/google/api/http_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: google/api/http.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'google/api/http.proto'

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/google/rpc/status_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: google/rpc/status.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'google/rpc/status.proto'

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/vald/v1/agent/core/agent_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: vald/v1/agent/core/agent.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'vald/v1/agent/core/agent.proto'

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/vald/v1/filter/egress/egress_filter_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: vald/v1/filter/egress/egress_filter.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'vald/v1/filter/egress/egress_filter.proto'

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/vald/v1/filter/ingress/ingress_filter_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: vald/v1/filter/ingress/ingress_filter.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'vald/v1/filter/ingress/ingress_filter.proto'

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/vald/v1/payload/payload_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: vald/v1/payload/payload.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'vald/v1/payload/payload.proto'

vald-client-python-1.7.16/src/vald/v1/rpc/errdetails/error_details_pb2.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: vald/v1/rpc/errdetails/error_details.proto
+# Protobuf Python Version: 5.29.2
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    5,
+    29,
+    2,
+    '',
+    'vald/v1/rpc/errdetails/error_details.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.protobuf import duration_pb2 as google_dot_protobuf_dot_duration__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n*vald/v1/rpc/errdetails/error_details.proto\x12\x06rpc.v1\x1a\x1egoogle/protobuf/duration.proto\"\xb5\x01\n\tErrorInfo\x12\x16\n\x06reason\x18\x01 \x01(\tR\x06reason\x12\x16\n\x06\x64omain\x18\x02 \x01(\tR\x06\x64omain\x12;\n\x08metadata\x18\x03 \x03(\x0b\x32\x1f.rpc.v1.ErrorInfo.MetadataEntryR\x08metadata\x1a;\n\rMetadataEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12\x14\n\x05value\x18\x02 \x01(\tR\x05value:\x02\x38\x01\"G\n\tRetryInfo\x12:\n\x0bretry_delay\x18\x01 \x01(\x0b\x32\x19.google.protobuf.DurationR\nretryDelay\"H\n\tDebugInfo\x12#\n\rstack_entries\x18\x01 \x03(\tR\x0cstackEntries\x12\x16\n\x06\x64\x65tail\x18\x02 \x01(\tR\x06\x64\x65tail\"\x97\x01\n\x0cQuotaFailure\x12>\n\nviolations\x18\x01 \x03(\x0b\x32\x1e.rpc.v1.QuotaFailure.ViolationR\nviolations\x1aG\n\tViolation\x12\x18\n\x07subject\x18\x01 \x01(\tR\x07subject\x12 \n\x0b\x64\x65scription\x18\x02 \x01(\tR\x0b\x64\x65scription\"\xb9\x01\n\x13PreconditionFailure\x12\x45\n\nviolations\x18\x01 \x03(\x0b\x32%.rpc.v1.PreconditionFailure.ViolationR\nviolations\x1a[\n\tViolation\x12\x12\n\x04type\x18\x01 \x01(\tR\x04type\x12\x18\n\x07subject\x18\x02 \x01(\tR\x07subject\x12 \n\x0b\x64\x65scription\x18\x03 \x01(\tR\x0b\x64\x65scription\"\xa4\x01\n\nBadRequest\x12L\n\x10\x66ield_violations\x18\x01 \x03(\x0b\x32!.rpc.v1.BadRequest.FieldViolationR\x0f\x66ieldViolations\x1aH\n\x0e\x46ieldViolation\x12\x14\n\x05\x66ield\x18\x01 \x01(\tR\x05\x66ield\x12 \n\x0b\x64\x65scription\x18\x02 \x01(\tR\x0b\x64\x65scription\"O\n\x0bRequestInfo\x12\x1d\n\nrequest_id\x18\x01 \x01(\tR\trequestId\x12!\n\x0cserving_data\x18\x02 \x01(\tR\x0bservingData\"\x90\x01\n\x0cResourceInfo\x12#\n\rresource_type\x18\x01 \x01(\tR\x0cresourceType\x12#\n\rresource_name\x18\x02 \x01(\tR\x0cresourceName\x12\x14\n\x05owner\x18\x03 \x01(\tR\x05owner\x12 \n\x0b\x64\x65scription\x18\x04 \x01(\tR\x0b\x64\x65scription\"k\n\x04Help\x12\'\n\x05links\x18\x01 \x03(\x0b\x32\x11.rpc.v1.Help.LinkR\x05links\x1a:\n\x04Link\x12 \n\x0b\x64\x65scription\x18\x01 \x01(\tR\x0b\x64\x65scription\x12\x10\n\x03url\x18\x02 \x01(\tR\x03url\"D\n\x10LocalizedMessage\x12\x16\n\x06locale\x18\x01 \x01(\tR\x06locale\x12\x18\n\x07message\x18\x02 \x01(\tR\x07messageBi\n\x19org.vdaas.vald.api.v1.rpcB\x11\x45rrorDetailsProtoP\x01Z1github.com/vdaas/vald/apis/grpc/v1/rpc/errdetails\xa2\x02\x03RPCb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'vald.v1.rpc.errdetails.error_details_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'\n\031org.vdaas.vald.api.v1.rpcB\021ErrorDetailsProtoP\001Z1github.com/vdaas/vald/apis/grpc/v1/rpc/errdetails\242\002\003RPC'
+  _globals['_ERRORINFO_METADATAENTRY']._loaded_options = None
+  _globals['_ERRORINFO_METADATAENTRY']._serialized_options = b'8\001'
+  _globals['_ERRORINFO']._serialized_start=87
+  _globals['_ERRORINFO']._serialized_end=268
+  _globals['_ERRORINFO_METADATAENTRY']._serialized_start=209
+  _globals['_ERRORINFO_METADATAENTRY']._serialized_end=268
+  _globals['_RETRYINFO']._serialized_start=270
+  _globals['_RETRYINFO']._serialized_end=341
+  _globals['_DEBUGINFO']._serialized_start=343
+  _globals['_DEBUGINFO']._serialized_end=415
+  _globals['_QUOTAFAILURE']._serialized_start=418
+  _globals['_QUOTAFAILURE']._serialized_end=569
+  _globals['_QUOTAFAILURE_VIOLATION']._serialized_start=498
+  _globals['_QUOTAFAILURE_VIOLATION']._serialized_end=569
+  _globals['_PRECONDITIONFAILURE']._serialized_start=572
+  _globals['_PRECONDITIONFAILURE']._serialized_end=757
+  _globals['_PRECONDITIONFAILURE_VIOLATION']._serialized_start=666
+  _globals['_PRECONDITIONFAILURE_VIOLATION']._serialized_end=757
+  _globals['_BADREQUEST']._serialized_start=760
+  _globals['_BADREQUEST']._serialized_end=924
+  _globals['_BADREQUEST_FIELDVIOLATION']._serialized_start=852
+  _globals['_BADREQUEST_FIELDVIOLATION']._serialized_end=924
+  _globals['_REQUESTINFO']._serialized_start=926
+  _globals['_REQUESTINFO']._serialized_end=1005
+  _globals['_RESOURCEINFO']._serialized_start=1008
+  _globals['_RESOURCEINFO']._serialized_end=1152
+  _globals['_HELP']._serialized_start=1154
+  _globals['_HELP']._serialized_end=1261
+  _globals['_HELP_LINK']._serialized_start=1203
+  _globals['_HELP_LINK']._serialized_end=1261
+  _globals['_LOCALIZEDMESSAGE']._serialized_start=1263
+  _globals['_LOCALIZEDMESSAGE']._serialized_end=1331
+# @@protoc_insertion_point(module_scope)

vald-client-python-1.7.16/src/vald/v1/rpc/errdetails/error_details_pb2_grpc.py

@@ -0,0 +1,4 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/vald/v1/vald/filter_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: vald/v1/vald/filter.proto
-# Protobuf Python Version: 5.28.2
+# Protobuf Python Version: 5.29.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,7 +12,7 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    28,
+    29,
     2,
     '',
     'vald/v1/vald/filter.proto'

{vald-client-python-1.7.14 → vald-client-python-1.7.16}/src/vald/v1/vald/filter_pb2_grpc.py

@@ -6,7 +6,10 @@ from vald.v1.payload import payload_pb2 as vald_dot_v1_dot_payload_dot_payload__
 
 
 class FilterStub(object):
-    """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.
     """
 
     def __init__(self, channel):
@@ -78,88 +81,224 @@ class FilterStub(object):
 
 
 class FilterServicer(object):
-    """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.
     """
 
     def SearchObject(self, request, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def MultiSearchObject(self, request, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def StreamSearchObject(self, request_iterator, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def InsertObject(self, request, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def StreamInsertObject(self, request_iterator, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def MultiInsertObject(self, request, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def UpdateObject(self, request, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def StreamUpdateObject(self, request_iterator, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def MultiUpdateObject(self, request, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def UpsertObject(self, request, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def StreamUpsertObject(self, request_iterator, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
     def MultiUpsertObject(self, request, context):
-        """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          |
         """
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
@@ -237,7 +376,10 @@ def add_FilterServicer_to_server(servicer, server):
 
  # This class is part of an EXPERIMENTAL API.
 class Filter(object):
-    """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.
     """
 
     @staticmethod

vald-client-python-1.7.16/src/vald/v1/vald/flush_pb2.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: vald/v1/vald/flush.proto
+# Protobuf Python Version: 5.29.2
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    5,
+    29,
+    2,
+    '',
+    'vald/v1/vald/flush.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2
+from vald.v1.payload import payload_pb2 as vald_dot_v1_dot_payload_dot_payload__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x18vald/v1/vald/flush.proto\x12\x07vald.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x1dvald/v1/payload/payload.proto2Y\n\x05\x46lush\x12P\n\x05\x46lush\x12\x19.payload.v1.Flush.Request\x1a\x1c.payload.v1.Info.Index.Count\"\x0e\x82\xd3\xe4\x93\x02\x08*\x06/flushBR\n\x1aorg.vdaas.vald.api.v1.valdB\tValdFlushP\x01Z\'github.com/vdaas/vald/apis/grpc/v1/valdb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'vald.v1.vald.flush_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'\n\032org.vdaas.vald.api.v1.valdB\tValdFlushP\001Z\'github.com/vdaas/vald/apis/grpc/v1/vald'
+  _globals['_FLUSH'].methods_by_name['Flush']._loaded_options = None
+  _globals['_FLUSH'].methods_by_name['Flush']._serialized_options = b'\202\323\344\223\002\010*\006/flush'
+  _globals['_FLUSH']._serialized_start=98
+  _globals['_FLUSH']._serialized_end=187
+# @@protoc_insertion_point(module_scope)