Align CreateRoleRequest/CreateUserRequest/SearchResponse/QueryResponse (#529)

with other SDKs

Signed-off-by: yhmo <yihua.mo@zilliz.com>

Author: yhmo

src/impl/MilvusClientV2Impl.cpp

@@ -1627,6 +1627,8 @@ MilvusClientV2Impl::Search(const SearchRequest& request, SearchResponse& respons
         }
         auto status = ConvertSearchResults(rpc_response, pk_name, results);
         response.SetResults(std::move(results));
+        response.SetSessionTs(rpc_response.session_ts());
+        FillSearchResponseExtraInfo(rpc_response.status(), response);
         return status;
     };
 
@@ -1730,6 +1732,8 @@ MilvusClientV2Impl::HybridSearch(const HybridSearchRequest& request, HybridSearc
         }
         auto status = ConvertSearchResults(rpc_response, pk_name, results);
         response.SetResults(std::move(results));
+        response.SetSessionTs(rpc_response.session_ts());
+        FillSearchResponseExtraInfo(rpc_response.status(), response);
         return status;
     };
 
@@ -1748,6 +1752,7 @@ MilvusClientV2Impl::Query(const QueryRequest& request, QueryResponse& response)
         QueryResults results;
         auto status = ConvertQueryResults(rpc_response, results);
         response.SetResults(std::move(results));
+        response.SetSessionTs(rpc_response.session_ts());
         return status;
     };
 
@@ -2677,6 +2682,7 @@ MilvusClientV2Impl::CreateUser(const CreateUserRequest& request) {
     auto pre = [&request](proto::milvus::CreateCredentialRequest& rpc_request) {
         rpc_request.set_username(request.UserName());
         rpc_request.set_password(milvus::Base64Encode(request.Password()));
+        rpc_request.set_description(request.Description());
         return Status::OK();
     };
 
@@ -2767,6 +2773,7 @@ Status
 MilvusClientV2Impl::CreateRole(const CreateRoleRequest& request) {
     auto pre = [&request](proto::milvus::CreateRoleRequest& rpc_request) {
         rpc_request.mutable_entity()->set_name(request.RoleName());
+        rpc_request.mutable_entity()->set_description(request.Description());
         return Status::OK();
     };
 

src/impl/request/rbac/CreateRoleRequest.cpp

@@ -30,7 +30,23 @@ CreateRoleRequest::SetRoleName(const std::string& name) {
 
 CreateRoleRequest&
 CreateRoleRequest::WithRoleName(const std::string& name) {
-    role_name_ = name;
+    SetRoleName(name);
+    return *this;
+}
+
+const std::string&
+CreateRoleRequest::Description() const {
+    return description_;
+}
+
+void
+CreateRoleRequest::SetDescription(const std::string& description) {
+    description_ = description;
+}
+
+CreateRoleRequest&
+CreateRoleRequest::WithDescription(const std::string& description) {
+    SetDescription(description);
     return *this;
 }
 

src/impl/request/rbac/CreateUserRequest.cpp

@@ -50,4 +50,20 @@ CreateUserRequest::WithPassword(const std::string& password) {
     return *this;
 }
 
+const std::string&
+CreateUserRequest::Description() const {
+    return description_;
+}
+
+void
+CreateUserRequest::SetDescription(const std::string& description) {
+    description_ = description;
+}
+
+CreateUserRequest&
+CreateUserRequest::WithDescription(const std::string& description) {
+    SetDescription(description);
+    return *this;
+}
+
 }  // namespace milvus

src/impl/response/dql/QueryResponse.cpp

@@ -30,4 +30,14 @@ QueryResponse::SetResults(QueryResults&& results) {
     results_ = std::move(results);
 }
 
+uint64_t
+QueryResponse::SessionTs() const {
+    return session_ts_;
+}
+
+void
+QueryResponse::SetSessionTs(uint64_t session_ts) {
+    session_ts_ = session_ts;
+}
+
 }  // namespace milvus

src/impl/response/dql/SearchResponse.cpp

@@ -30,4 +30,54 @@ SearchResponse::SetResults(SearchResults&& results) {
     results_ = std::move(results);
 }
 
+uint64_t
+SearchResponse::SessionTs() const {
+    return session_ts_;
+}
+
+void
+SearchResponse::SetSessionTs(uint64_t session_ts) {
+    session_ts_ = session_ts;
+}
+
+int64_t
+SearchResponse::Cost() const {
+    return cost_;
+}
+
+void
+SearchResponse::SetCost(int64_t cost) {
+    cost_ = cost;
+}
+
+int64_t
+SearchResponse::ScannedRemoteBytes() const {
+    return scanned_remote_bytes_;
+}
+
+void
+SearchResponse::SetScannedRemoteBytes(int64_t scanned_remote_bytes) {
+    scanned_remote_bytes_ = scanned_remote_bytes;
+}
+
+int64_t
+SearchResponse::ScannedTotalBytes() const {
+    return scanned_total_bytes_;
+}
+
+void
+SearchResponse::SetScannedTotalBytes(int64_t scanned_total_bytes) {
+    scanned_total_bytes_ = scanned_total_bytes;
+}
+
+float
+SearchResponse::CacheHitRatio() const {
+    return cache_hit_ratio_;
+}
+
+void
+SearchResponse::SetCacheHitRatio(float cache_hit_ratio) {
+    cache_hit_ratio_ = cache_hit_ratio;
+}
+
 }  // namespace milvus

src/impl/utils/DqlUtils.cpp

@@ -17,11 +17,14 @@
 #include "DqlUtils.h"
 
 #include <set>
+#include <string>
 
 #include "./Constants.h"
 #include "./DmlUtils.h"
 #include "./GtsDict.h"
+#include "./MiscUtils.h"
 #include "./TypeUtils.h"
+#include "milvus/response/dql/SearchResponse.h"
 #include "milvus/types/Constants.h"
 #include "milvus/utils/FP16.h"
 
@@ -61,6 +64,48 @@ SetSearchHighlighter(const T&, proto::milvus::SearchRequest&) {
 
 }  // namespace
 
+void
+FillSearchResponseExtraInfo(const proto::common::Status& status, SearchResponse& response) {
+    response.SetCost(-1);
+    response.SetScannedRemoteBytes(-1);
+    response.SetScannedTotalBytes(-1);
+    response.SetCacheHitRatio(-1.0f);
+
+    const auto& extra_info = status.extra_info();
+
+    const auto cost_it = extra_info.find("report_value");
+    if (cost_it != extra_info.end()) {
+        try {
+            response.SetCost(std::stoll(cost_it->second));
+        } catch (...) {
+        }
+    }
+
+    const auto remote_bytes_it = extra_info.find("scanned_remote_bytes");
+    if (remote_bytes_it != extra_info.end()) {
+        try {
+            response.SetScannedRemoteBytes(std::stoll(remote_bytes_it->second));
+        } catch (...) {
+        }
+    }
+
+    const auto total_bytes_it = extra_info.find("scanned_total_bytes");
+    if (total_bytes_it != extra_info.end()) {
+        try {
+            response.SetScannedTotalBytes(std::stoll(total_bytes_it->second));
+        } catch (...) {
+        }
+    }
+
+    const auto cache_hit_ratio_it = extra_info.find("cache_hit_ratio");
+    if (cache_hit_ratio_it != extra_info.end()) {
+        float cache_hit_ratio = 0.0f;
+        if (ParseFloatWithLocale(cache_hit_ratio_it->second, cache_hit_ratio, std::locale::classic())) {
+            response.SetCacheHitRatio(cache_hit_ratio);
+        }
+    }
+}
+
 SparseFloatVecFieldData::ElementT
 DecodeSparseFloatVector(const std::string& bytes) {
     if (bytes.size() % 8 != 0) {

src/impl/utils/DqlUtils.h

@@ -33,6 +33,8 @@
 #include "schema.pb.h"
 
 namespace milvus {
+class SearchResponse;
+
 Status
 CreateMilvusFieldData(const proto::schema::FieldData& proto_data, size_t offset, size_t count,
                       FieldDataPtr& field_data);
@@ -87,6 +89,9 @@ Status
 ConvertSearchResults(const proto::milvus::SearchResults& rpc_results, const std::string& pk_name,
                      SearchResults& results);
 
+void
+FillSearchResponseExtraInfo(const proto::common::Status& status, SearchResponse& response);
+
 template <typename T>
 Status
 ConvertHybridSearchRequest(const T& request, const std::string& current_db,

src/impl/utils/MiscUtils.cpp

@@ -19,6 +19,8 @@
 #include <cctype>
 #include <cmath>
 #include <limits>
+#include <locale>
+#include <sstream>
 
 namespace {
 
@@ -114,6 +116,14 @@ UpperWithoutSpaces(const std::string& value) {
     return result;
 }
 
+bool
+ParseFloatWithLocale(const std::string& text, float& value, const std::locale& locale) {
+    std::istringstream stream(text);
+    stream.imbue(locale);
+    stream >> std::noskipws >> value;
+    return stream && stream.eof();
+}
+
 Status
 ParseTargetSizeMB(const std::string& target_size, int64_t& target_size_mb, std::string& normalized) {
     target_size_mb = 0;

src/impl/utils/MiscUtils.h

@@ -32,4 +32,8 @@ UpperWithoutSpaces(const std::string& value);
 Status
 ParseTargetSizeMB(const std::string& target_size, int64_t& target_size_mb, std::string& normalized);
 
+// Protocol and other machine-readable float text should not depend on the process locale.
+bool
+ParseFloatWithLocale(const std::string& text, float& value, const std::locale& locale);
+
 }  // namespace milvus

src/include/milvus/request/rbac/CreateRoleRequest.h

@@ -50,8 +50,27 @@ class MILVUS_SDK_API CreateRoleRequest {
     CreateRoleRequest&
     WithRoleName(const std::string& name);
 
+    /**
+     * @brief Description of the role.
+     */
+    const std::string&
+    Description() const;
+
+    /**
+     * @brief Set description of the role.
+     */
+    void
+    SetDescription(const std::string& description);
+
+    /**
+     * @brief Set description of the role.
+     */
+    CreateRoleRequest&
+    WithDescription(const std::string& description);
+
  protected:
     std::string role_name_;
+    std::string description_;
 };
 
 }  // namespace milvus