package milvus.proto.common

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: milvus.RegisterLinkResponse

string ip = 1
int64 port = 2

Used in: msg.InsertRequest

bytes value = 1

Used in: milvus.ClientHeartbeatResponse

string command_id = 1
string command_type = 2
bytes payload = 3
int64 create_time = 4
bool persistent = 5
string target_scope = 6

Used in: milvus.ClientHeartbeatRequest, milvus.ClientTelemetry, milvus.ConnectRequest

string sdk_type = 1
sdk_type can be `python`, `golang`, `nodejs` and etc. It's not proper to make `sdk_type` an enumerate type, since we cannot always update the enum value everytime when newly sdk is supported.
string sdk_version = 2
string local_time = 3
string user = 4
string host = 5
map<string, string> reserved = 6
reserved for newly-added feature if necessary.

message CommandReply

common.proto:581

Used in: milvus.ClientHeartbeatRequest

string command_id = 1
bool success = 2
string error_message = 3
bytes payload = 4

Used in: milvus.GetCompactionPlansResponse, milvus.GetCompactionStateResponse

UndefiedState = 0
Executing = 1
Completed = 2

ConnectionParam defines the params to connect to the Milvus cluster.

Used in: MilvusCluster

string uri = 1
string token = 2

Used in: milvus.CreateCollectionRequest, milvus.DeleteRequest, milvus.DescribeCollectionResponse, milvus.HybridSearchRequest, milvus.QueryRequest, milvus.SearchRequest

Strong = 0
Session = 1
default in PyMilvus
Bounded = 2
Eventually = 3
Customized = 4
Users pass their own `guarantee_timestamp`.

CrossClusterTopology is the topology that describes the topology cross multiple cluster milvus.

Used in: ReplicateConfiguration

string source_cluster_id = 1
string target_cluster_id = 2

Don't Modify This. @czs

optional MsgBase base = 1
string shardName = 2

Used in: milvus.SearchRequest, milvus.SubSearchRequest

Dsl = 0
BoolExprV1 = 1

Deprecated

Used in: Status

Success = 0
UnexpectedError = 1
ConnectFailed = 2
PermissionDenied = 3
CollectionNotExists = 4
IllegalArgument = 5
IllegalDimension = 7
IllegalIndexType = 8
IllegalCollectionName = 9
IllegalTOPK = 10
IllegalRowRecord = 11
IllegalVectorID = 12
IllegalSearchResult = 13
FileNotFound = 14
MetaFailed = 15
CacheFailed = 16
CannotCreateFolder = 17
CannotCreateFile = 18
CannotDeleteFolder = 19
CannotDeleteFile = 20
BuildIndexError = 21
IllegalNLIST = 22
IllegalMetricType = 23
OutOfMemory = 24
IndexNotExist = 25
EmptyCollection = 26
UpdateImportTaskFailure = 27
CollectionNameNotFound = 28
CreateCredentialFailure = 29
UpdateCredentialFailure = 30
DeleteCredentialFailure = 31
GetCredentialFailure = 32
ListCredUsersFailure = 33
GetUserFailure = 34
CreateRoleFailure = 35
DropRoleFailure = 36
OperateUserRoleFailure = 37
SelectRoleFailure = 38
SelectUserFailure = 39
SelectResourceFailure = 40
OperatePrivilegeFailure = 41
SelectGrantFailure = 42
RefreshPolicyInfoCacheFailure = 43
ListPolicyFailure = 44
NotShardLeader = 45
NoReplicaAvailable = 46
SegmentNotFound = 47
ForceDeny = 48
RateLimit = 49
NodeIDNotMatch = 50
UpsertAutoIDTrue = 51
InsufficientMemoryToLoad = 52
MemoryQuotaExhausted = 53
DiskQuotaExhausted = 54
TimeTickLongDelay = 55
NotReadyServe = 56
NotReadyCoordActivating = 57
Coord is switching from standby mode to active mode
CreatePrivilegeGroupFailure = 58
DropPrivilegeGroupFailure = 59
ListPrivilegeGroupsFailure = 60
OperatePrivilegeGroupFailure = 61
SchemaMismatch = 62
DataCoordNA = 100
Service availability. NA: Not Available.
DDRequestRace = 1000
internal error code.

Used in: HighlightResult

repeated string fragments = 1
repeated float scores = 2

Used in: schema.SearchResultData

string field_name = 1
repeated HighlightData datas = 2

Used in: Highlighter

Lexical = 0
Semantic = 1

Used in: milvus.SearchRequest

HighlightType type = 1
repeated KeyValuePair params = 2

message ImmutableMessage

common.proto:653

ImmutableMessage is the message that can not be modified anymore.

Used in: milvus.DumpMessagesResponse, milvus.FlushAllResponse, milvus.ReplicateMessage

optional MessageID id = 1
message id
bytes payload = 2
message body
map<string, string> properties = 3
message properties

Used in: milvus.GetImportStateResponse

ImportPending = 0
the task in in pending list of rootCoord, waiting to be executed
ImportFailed = 1
the task failed for some reason, get detail reason from GetImportStateResponse.infos
ImportStarted = 2
the task has been sent to datanode to execute
ImportPersisted = 5
all data files have been parsed and all meta data already persisted, ready to be flushed.
ImportFlushed = 8
all segments are successfully flushed.
ImportCompleted = 6
all indexes are successfully built and segments are able to be compacted as normal.
ImportFailedAndCleaned = 7
the task failed and all segments it generated are cleaned up.

Used in: milvus.GetIndexStateResponse, milvus.IndexDescription

IndexStateNone = 0
Unissued = 1
InProgress = 2
Finished = 3
Failed = 4
Retry = 5

Used in: milvus.DescribeCollectionResponse

string key = 1
bytes data = 2

Used in: Highlighter, feder.DescribeSegmentIndexDataResponse, milvus.AlterCollectionFieldRequest, milvus.AlterCollectionRequest, milvus.AlterCollectionSchemaRequest.FieldInfo, milvus.AlterDatabaseRequest, milvus.AlterIndexRequest, milvus.CalcDistanceRequest, milvus.ComponentInfo, milvus.CreateCollectionRequest, milvus.CreateDatabaseRequest, milvus.CreateIndexRequest, milvus.DescribeCollectionResponse, milvus.DescribeDatabaseResponse, milvus.GetCollectionStatisticsResponse, milvus.GetImportStateResponse, milvus.GetPartitionStatisticsResponse, milvus.GetStatisticsResponse, milvus.HybridSearchRequest, milvus.ImportRequest, milvus.IndexDescription, milvus.QueryRequest, milvus.SearchRequest, milvus.SubSearchRequest, rg.ResourceGroupNodeFilter, schema.CollectionSchema, schema.FieldSchema, schema.FunctionSchema, schema.FunctionScore, schema.StructArrayFieldSchema

string key = 1
string value = 2

HIGH = 0
LOW = 1

Used in: milvus.GetLoadStateResponse

LoadStateNotExist = 0
LoadStateNotLoad = 1
LoadStateLoading = 2
LoadStateLoaded = 3

message MessageID

common.proto:647

Used in: ImmutableMessage, ReplicateCheckpoint, milvus.DumpMessagesRequest

string id = 1
WALName WAL_name = 2

Used in: SearchAggregationSpec

string op = 1
"avg" | "sum" | "count" | "min" | "max"
string field_name = 2
field name | "_score" | "*" (count(*))

Used in: OperationMetrics, milvus.GetClientTelemetryResponse

int64 request_count = 1
int64 success_count = 2
int64 error_count = 3
double avg_latency_ms = 4
double p99_latency_ms = 5
double max_latency_ms = 6

MilvusCluster describes the Milvus cluster information, including pchannel mapping details.

Used in: ReplicateConfiguration

string cluster_id = 1
optional ConnectionParam connection_param = 2
repeated string pchannels = 3

MsgType msg_type = 1
int64 msgID = 2
uint64 timestamp = 3
int64 sourceID = 4
int64 targetID = 5
map<string, string> properties = 6
optional ReplicateInfo replicateInfo = 7

Don't Modify This. @czs

optional MsgBase base = 1

Used in: MsgBase

Undefined = 0
CreateCollection = 100
DEFINITION REQUESTS: COLLECTION
DropCollection = 101
HasCollection = 102
DescribeCollection = 103
ShowCollections = 104
GetSystemConfigs = 105
LoadCollection = 106
ReleaseCollection = 107
CreateAlias = 108
DropAlias = 109
AlterAlias = 110
AlterCollection = 111
RenameCollection = 112
DescribeAlias = 113
ListAliases = 114
AlterCollectionField = 115
AddCollectionFunction = 116
AlterCollectionFunction = 117
DropCollectionFunction = 118
TruncateCollection = 119
CreatePartition = 200
DEFINITION REQUESTS: PARTITION
DropPartition = 201
HasPartition = 202
DescribePartition = 203
ShowPartitions = 204
LoadPartitions = 205
ReleasePartitions = 206
ShowSegments = 250
DEFINE REQUESTS: SEGMENT
DescribeSegment = 251
LoadSegments = 252
ReleaseSegments = 253
HandoffSegments = 254
LoadBalanceSegments = 255
DescribeSegments = 256
FederListIndexedSegment = 257
FederDescribeSegmentIndexData = 258
CreateIndex = 300
DEFINITION REQUESTS: INDEX
DescribeIndex = 301
DropIndex = 302
GetIndexStatistics = 303
AlterIndex = 304
Insert = 400
MANIPULATION REQUESTS
Delete = 401
Flush = 402
ResendSegmentStats = 403
Upsert = 404
ManualFlush = 405
streaming service new msg type for internal usage compatible
FlushSegment = 406
streaming service new msg type for internal usage compatible
CreateSegment = 407
streaming service new msg type for internal usage compatible
Import = 408
FlushAll = 409
streaming service new msg type for internal usage compatible
Search = 500
QUERY
SearchResult = 501
GetIndexState = 502
GetIndexBuildProgress = 503
GetCollectionStatistics = 504
GetPartitionStatistics = 505
Retrieve = 506
RetrieveResult = 507
WatchDmChannels = 508
RemoveDmChannels = 509
WatchQueryChannels = 510
RemoveQueryChannels = 511
SealedSegmentsChangeInfo = 512
WatchDeltaChannels = 513
GetShardLeaders = 514
GetReplicas = 515
UnsubDmChannel = 516
GetDistribution = 517
SyncDistribution = 518
RunAnalyzer = 519
SegmentInfo = 600
DATA SERVICE
SystemInfo = 601
GetRecoveryInfo = 602
GetSegmentState = 603
TimeTick = 1200
SYSTEM CONTROL
QueryNodeStats = 1201
GOOSE TODO: Remove kQueryNodeStats
LoadIndex = 1202
RequestID = 1203
RequestTSO = 1204
AllocateSegment = 1205
SegmentStatistics = 1206
SegmentFlushDone = 1207
DataNodeTt = 1208
Connect = 1209
ListClientInfos = 1210
AllocTimestamp = 1211
Replicate = 1212
CreateCredential = 1500
Credential
GetCredential = 1501
DeleteCredential = 1502
UpdateCredential = 1503
ListCredUsernames = 1504
CreateRole = 1600
RBAC
DropRole = 1601
OperateUserRole = 1602
SelectRole = 1603
SelectUser = 1604
SelectResource = 1605
OperatePrivilege = 1606
SelectGrant = 1607
RefreshPolicyInfoCache = 1608
ListPolicy = 1609
CreatePrivilegeGroup = 1610
DropPrivilegeGroup = 1611
ListPrivilegeGroups = 1612
OperatePrivilegeGroup = 1613
OperatePrivilegeV2 = 1614
AlterRole = 1615
CreateResourceGroup = 1700
Resource group
DropResourceGroup = 1701
ListResourceGroups = 1702
DescribeResourceGroup = 1703
TransferNode = 1704
TransferReplica = 1705
UpdateResourceGroups = 1706
CreateDatabase = 1801
Database group
DropDatabase = 1802
ListDatabases = 1803
AlterDatabase = 1804
DescribeDatabase = 1805
AddCollectionField = 1900
AlterWAL = 2000
WAL group
CreateSnapshot = 2100
Snapshot
DropSnapshot = 2101
ListSnapshots = 2102
DescribeSnapshot = 2103
RestoreSnapshot = 2104
GetRestoreSnapshotState = 2105
ListRestoreSnapshotJobs = 2106
PinSnapshotData = 2107
UnpinSnapshotData = 2108
RestoreExternalSnapshot = 2109
ExportSnapshot = 2110
AlterCollectionSchema = 2200
RefreshExternalCollection = 2300
External Collection
GetRefreshExternalCollectionProgress = 2301
ListRefreshExternalCollectionJobs = 2302

NodeInfo is used to describe the node information.

Used in: milvus.ResourceGroup

int64 node_id = 1
string address = 2
string hostname = 3

Used in: PrivilegeExt

PrivilegeAll = 0
PrivilegeCreateCollection = 1
PrivilegeDropCollection = 2
PrivilegeDescribeCollection = 3
PrivilegeShowCollections = 4
PrivilegeLoad = 5
PrivilegeRelease = 6
PrivilegeCompaction = 7
PrivilegeInsert = 8
PrivilegeDelete = 9
PrivilegeGetStatistics = 10
PrivilegeCreateIndex = 11
PrivilegeIndexDetail = 12
PrivilegeDropIndex = 13
PrivilegeSearch = 14
PrivilegeFlush = 15
PrivilegeQuery = 16
PrivilegeLoadBalance = 17
PrivilegeImport = 18
PrivilegeCreateOwnership = 19
PrivilegeUpdateUser = 20
PrivilegeDropOwnership = 21
PrivilegeSelectOwnership = 22
PrivilegeManageOwnership = 23
PrivilegeSelectUser = 24
PrivilegeUpsert = 25
PrivilegeCreateResourceGroup = 26
PrivilegeDropResourceGroup = 27
PrivilegeDescribeResourceGroup = 28
PrivilegeListResourceGroups = 29
PrivilegeTransferNode = 30
PrivilegeTransferReplica = 31
PrivilegeGetLoadingProgress = 32
PrivilegeGetLoadState = 33
PrivilegeRenameCollection = 34
PrivilegeCreateDatabase = 35
PrivilegeDropDatabase = 36
PrivilegeListDatabases = 37
PrivilegeFlushAll = 38
PrivilegeCreatePartition = 39
PrivilegeDropPartition = 40
PrivilegeShowPartitions = 41
PrivilegeHasPartition = 42
PrivilegeGetFlushState = 43
PrivilegeCreateAlias = 44
PrivilegeDropAlias = 45
PrivilegeDescribeAlias = 46
PrivilegeListAliases = 47
PrivilegeUpdateResourceGroups = 48
PrivilegeAlterDatabase = 49
PrivilegeDescribeDatabase = 50
PrivilegeBackupRBAC = 51
PrivilegeRestoreRBAC = 52
PrivilegeGroupReadOnly = 53
PrivilegeGroupReadWrite = 54
PrivilegeGroupAdmin = 55
PrivilegeCreatePrivilegeGroup = 56
PrivilegeDropPrivilegeGroup = 57
PrivilegeListPrivilegeGroups = 58
PrivilegeOperatePrivilegeGroup = 59
PrivilegeGroupClusterReadOnly = 60
PrivilegeGroupClusterReadWrite = 61
PrivilegeGroupClusterAdmin = 62
PrivilegeGroupDatabaseReadOnly = 63
PrivilegeGroupDatabaseReadWrite = 64
PrivilegeGroupDatabaseAdmin = 65
PrivilegeGroupCollectionReadOnly = 66
PrivilegeGroupCollectionReadWrite = 67
PrivilegeGroupCollectionAdmin = 68
PrivilegeGetImportProgress = 69
PrivilegeListImport = 70
PrivilegeAddCollectionField = 71
PrivilegeAddFileResource = 72
PrivilegeRemoveFileResource = 73
PrivilegeListFileResources = 74
PrivilegeUpdateReplicateConfiguration = 78
PrivilegeCreateSnapshot = 79
PrivilegeDropSnapshot = 80
PrivilegeDescribeSnapshot = 81
PrivilegeListSnapshots = 82
PrivilegeRestoreSnapshot = 83
PrivilegeAlterCollectionSchema = 84
PrivilegeGetReplicateConfiguration = 85
PrivilegeRefreshExternalCollection = 86
PrivilegePinSnapshotData = 87
PrivilegeUnpinSnapshotData = 88
PrivilegeRestoreExternalSnapshot = 89
PrivilegeExportSnapshot = 90

Used in: PrivilegeExt

Collection = 0
Global = 1
User = 2

Used in: milvus.ClientHeartbeatRequest, milvus.ClientTelemetry

string operation = 1
optional Metrics global = 2
map<string, Metrics> collection_metrics = 3

Used in: SearchAggregationSpec

string key = 1
metric alias | "_count" | "_key"
string direction = 2
"asc" | "desc"
bool null_first = 3

repeated PlaceholderValue placeholders = 1

Used in: PlaceholderValue

None = 0
BinaryVector = 100
FloatVector = 101
Float16Vector = 102
BFloat16Vector = 103
SparseFloatVector = 104
Int8Vector = 105
Int64 = 5
VarChar = 21
EmbListBinaryVector = 300
EmbListFloatVector = 301
EmbListFloat16Vector = 302
EmbListBFloat16Vector = 303
EmbListSparseFloatVector = 304
EmbListInt8Vector = 305

Used in: PlaceholderGroup

string tag = 1
PlaceholderType type = 2
repeated bytes values = 3
values is a 2d-array of nq rows, every row contains a query vector. for dense vector, all rows are of the same length; for sparse vector, the length of each row may vary depending on their number of non-zeros.
bool element_level = 4

ObjectType object_type = 1
ObjectPrivilege object_privilege = 2
int32 object_name_index = 3
int32 object_name_indexs = 4

ReplicateCheckpoint is the WAL replicate checkpoint of source cluster. It will be persisted in the target cluster metadata. When a replication started, we will get the replicate checkpoint from target cluster metadata. And use it to continue the replication at source cluster.

Used in: milvus.GetReplicateInfoResponse

string cluster_id = 1
the cluster id of source cluster
string pchannel = 2
the pchannel of source cluster
optional MessageID message_id = 3
the last confirmed message id of the last replicated message
uint64 time_tick = 4
the time tick of the last replicated message

ReplicateConfiguration is the configuration that describes the replication topology cross multiple cluster milvus.

Used in: milvus.GetReplicateConfigurationResponse, milvus.UpdateReplicateConfigurationRequest

repeated MilvusCluster clusters = 1
repeated CrossClusterTopology cross_cluster_topology = 2

Used in: MsgBase

bool isReplicate = 1
uint64 msgTimestamp = 2
string replicateID = 3

Used in: milvus.SearchRequest

repeated string fields = 1
field names, JSON path expression OK
int64 size = 2
max buckets returned at this level
map<string, MetricAggSpec> metrics = 3
alias -> MetricAggSpec
repeated OrderSpec order = 4
index 0 = highest priority
optional TopHitsSpec top_hits = 5
nil = pure aggregation level
optional SearchAggregationSpec sub_aggregation = 6
recursive nesting
int64 search_size = 7
candidate buckets searched at this level; 0 means size

Used in: milvus.PersistentSegmentInfo, milvus.QuerySegmentInfo

Legacy = 0
zero value for legacy logic
L0 = 1
L0 segment, contains delta data for current channel
L1 = 2
L1 segment, normal segment, with no extra compaction attribute
L2 = 3
L2 segment, segment with extra data distribution info

Used in: milvus.PersistentSegmentInfo, milvus.QuerySegmentInfo

SegmentStateNone = 0
NotExist = 1
Growing = 2
Sealed = 3
Flushed = 4
Flushing = 5
Dropped = 6
Importing = 7

Used in: msg.DataNodeTtMsg

int64 SegmentID = 1
int64 NumRows = 2

Used in: milvus.ConnectResponse

string build_tags = 1
string build_time = 2
string git_commit = 3
string go_version = 4
string deploy_mode = 5
map<string, string> reserved = 6
reserved for newly-added feature if necessary.

Used in: TopHitsSpec

string field_name = 1
field name (JSON path expression OK) | "_score"
string direction = 2
"asc" | "desc"
bool null_first = 3

Used in: milvus.ComponentInfo

Initializing = 0
Healthy = 1
Abnormal = 2
StandBy = 3
Stopping = 4

ErrorCode error_code = 1
string reason = 2
int32 code = 3
bool retriable = 4
string detail = 5
map<string, string> extra_info = 6

Used in: SearchAggregationSpec

int64 size = 1
repeated SortSpec sort = 2

Used in: MessageID, msg.MsgPosition

Unknown = 0
RocksMQ = 1
Pulsar = 2
Kafka = 3
WoodPecker = 4
Test = 999

package milvus.proto.common

message Address

string ip = 1

int64 port = 2

message Blob

bytes value = 1

message ClientCommand

string command_id = 1

string command_type = 2

bytes payload = 3

int64 create_time = 4

bool persistent = 5

string target_scope = 6

message ClientInfo

string sdk_type = 1

string sdk_version = 2

string local_time = 3

string user = 4

string host = 5

map<string, string> reserved = 6

message CommandReply

string command_id = 1

bool success = 2

string error_message = 3

bytes payload = 4

enum CompactionState

UndefiedState = 0

Executing = 1

Completed = 2

message ConnectionParam

string uri = 1

string token = 2

enum ConsistencyLevel

Strong = 0

Session = 1

Bounded = 2

Eventually = 3

Customized = 4

message CrossClusterTopology

string source_cluster_id = 1

string target_cluster_id = 2

message DMLMsgHeader

optional MsgBase base = 1

string shardName = 2

enum DslType

Dsl = 0

BoolExprV1 = 1

enum ErrorCode

Success = 0

UnexpectedError = 1

ConnectFailed = 2

PermissionDenied = 3

CollectionNotExists = 4

IllegalArgument = 5

IllegalDimension = 7

IllegalIndexType = 8

IllegalCollectionName = 9

IllegalTOPK = 10

IllegalRowRecord = 11

IllegalVectorID = 12

IllegalSearchResult = 13

FileNotFound = 14

MetaFailed = 15

CacheFailed = 16

CannotCreateFolder = 17

CannotCreateFile = 18

CannotDeleteFolder = 19

CannotDeleteFile = 20

BuildIndexError = 21

IllegalNLIST = 22

IllegalMetricType = 23

OutOfMemory = 24

IndexNotExist = 25

EmptyCollection = 26

UpdateImportTaskFailure = 27

CollectionNameNotFound = 28

CreateCredentialFailure = 29

UpdateCredentialFailure = 30

DeleteCredentialFailure = 31

GetCredentialFailure = 32