From c9926401763b9b712ec66cb476223efb6a4b91c3 Mon Sep 17 00:00:00 2001 From: nameczz Date: Thu, 14 Oct 2021 18:46:59 +0800 Subject: [PATCH] [skip ci] Add create index comments in milvus.proto (#9852) Signed-off-by: Gitea --- internal/proto/milvus.proto | 16 ++++++++++++---- internal/proto/milvuspb/milvus.pb.go | 15 +++++++++++---- 2 files changed, 23 insertions(+), 8 deletions(-) diff --git a/internal/proto/milvus.proto b/internal/proto/milvus.proto index de86f76704..77e032fc51 100644 --- a/internal/proto/milvus.proto +++ b/internal/proto/milvus.proto @@ -411,12 +411,20 @@ message ShowSegmentsResponse { repeated int64 segmentIDs = 2; } +/* +* Create index for vector datas +*/ message CreateIndexRequest { - common.MsgBase base = 1; // must + // Not useful for now + common.MsgBase base = 1; + // Not useful for now string db_name = 2; - string collection_name = 3; // must - string field_name = 4; // must - repeated common.KeyValuePair extra_params = 5; // must + // The particular collection name you want to create index. + string collection_name = 3; + // The vector field name in this particular collection + string field_name = 4; + // Support keys: index_type,metric_type, params. Different index_type may has different params. + repeated common.KeyValuePair extra_params = 5; } message DescribeIndexRequest { diff --git a/internal/proto/milvuspb/milvus.pb.go b/internal/proto/milvuspb/milvus.pb.go index 62ce4dfd1d..54d324d93f 100644 --- a/internal/proto/milvuspb/milvus.pb.go +++ b/internal/proto/milvuspb/milvus.pb.go @@ -2021,11 +2021,18 @@ func (m *ShowSegmentsResponse) GetSegmentIDs() []int64 { return nil } +// +// Create index for vector datas type CreateIndexRequest struct { - Base *commonpb.MsgBase `protobuf:"bytes,1,opt,name=base,proto3" json:"base,omitempty"` - DbName string `protobuf:"bytes,2,opt,name=db_name,json=dbName,proto3" json:"db_name,omitempty"` - CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"` - FieldName string `protobuf:"bytes,4,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"` + // Not useful for now + Base *commonpb.MsgBase `protobuf:"bytes,1,opt,name=base,proto3" json:"base,omitempty"` + // Not useful for now + DbName string `protobuf:"bytes,2,opt,name=db_name,json=dbName,proto3" json:"db_name,omitempty"` + // The particular collection name you want to create index. + CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"` + // The vector field name in this particular collection + FieldName string `protobuf:"bytes,4,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"` + // Support keys: index_type,metric_type, params. Different index_type may has different params. ExtraParams []*commonpb.KeyValuePair `protobuf:"bytes,5,rep,name=extra_params,json=extraParams,proto3" json:"extra_params,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"`