milvus/docs/developer_guides/chap03_index_builder.md
GuoRentong 1abc69277b Update doc: service api
Signed-off-by: GuoRentong <rentong.guo@zilliz.com>
2020-12-29 18:02:44 +08:00

874 B

8. Index Service

8.1 Overview

8.2 API

type Client interface {
  BuildIndex(req BuildIndexRequest) (BuildIndexResponse, error)
	DescribeIndex(indexID UniqueID) (IndexDescription, error)
	GetIndexFilePaths(indexID UniqueID) (IndexFilePaths, error)
}
  • BuildIndex
type BuildIndexRequest struct {
  DataPaths []string
  TypeParams map[string]string
  IndexParams map[string]string
}

type BuildIndexResponse struct {
  IndexID UniqueID
}
  • DescribeIndex
enum IndexStatus {
    NONE = 0;
    UNISSUED = 1;
    INPROGRESS = 2;
    FINISHED = 3;
}

type IndexDescription struct {
	ID                UniqueID
	Status            IndexStatus
	EnqueueTime       time.Time
	ScheduleTime      time.Time
	BuildCompleteTime time.Time
}
  • GetIndexFilePaths
type IndexFilePaths struct {
  FilePaths []string
}