feat: support to query file details when uploading files to collection

Author: averiewang

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v1.7.2
+* feat: support float16_vector/bfloat16_vector types for HNSW vector
+* feat: support to query file details when uploading files to collection 
 
 ## v1.7.1
 * fix: Keep using collection/collectionView user defined to access the interface within the Collection/AICollectionView object

example/collection_upload_file_demo/main.go

@@ -16,11 +16,11 @@ import (
 )
 
 type Demo struct {
-	client *tcvectordb.RpcClient
+	client *tcvectordb.Client
 }
 
 func NewDemo(url, username, key string) (*Demo, error) {
-	cli, err := tcvectordb.NewRpcClient(url, username, key, &tcvectordb.ClientOption{
+	cli, err := tcvectordb.NewClient(url, username, key, &tcvectordb.ClientOption{
 		ReadConsistency: tcvectordb.StrongConsistency})
 	if err != nil {
 		return nil, err
@@ -109,8 +109,14 @@ func (d *Demo) UploadFile(ctx context.Context, database, collection, localFilePa
 			"sectionNum": "section_num",
 		},
 		MetaData: map[string]interface{}{
-			"testStr": "v1",
-			"testInt": 1024,
+			"testStr":    "v1",
+			"testInt":    1024,
+			"testDouble": 0.1,
+			"testArray":  []string{"one", "two"},
+			"testJson": map[string]interface{}{
+				"a": 1,
+				"b": "str",
+			},
 		},
 	}
 
@@ -125,6 +131,22 @@ func (d *Demo) UploadFile(ctx context.Context, database, collection, localFilePa
 
 func (d *Demo) QueryData(ctx context.Context, database, collection, filename string) error {
 	time.Sleep(15 * time.Second)
+	log.Println("------------------------------ Query file details after waiting 15s to parse file ------------------------------")
+	//limit := int64(2)
+	fileDetialRes, err := d.client.QueryFileDetails(ctx, database, collection, &tcvectordb.QueryFileDetailsParams{
+		FileNames: []string{filename},
+		// Filter:       tcvectordb.NewFilter(`_indexed_status = \"Ready\"`),
+		// Limit:        &limit,
+		// Offset:       0,
+		// OutputFields: []string{"id", "_indexed_status", "_user_metadata"},
+	})
+	if err != nil {
+		return err
+	}
+	for _, doc := range fileDetialRes.Documents {
+		log.Printf("File detail: %+v", doc)
+	}
+
 	log.Println("------------------------------ Query after waiting 15s to parse file ------------------------------")
 
 	result, err := d.client.Query(ctx, database, collection, []string{}, &tcvectordb.QueryDocumentParams{
@@ -253,21 +275,23 @@ func printErr(err error) {
 }
 
 func main() {
-	database := "go-sdk-demo-db"
-	collectionName := "go-sdk-demo-col-test4"
+	database := "test-db"
+	collectionName := "test-coll"
 
 	_, filePath, _, _ := runtime.Caller(0)
-	localFilePath := path.Join(path.Dir(filePath), "../demo_files/tcvdb.pdf")
+	localFilePath := path.Join(path.Dir(filePath), "../demo_files/tcvdb.md")
 	filename := filepath.Base(localFilePath)
 
 	ctx := context.Background()
 	testVdb, err := NewDemo("vdb http url or ip and port", "vdb username", "key get from web console")
+	printErr(err)
+	err = testVdb.DeleteAndDrop(ctx, database, collectionName)
+	printErr(err)
 	err = testVdb.CreateDBAndCollection(ctx, database, collectionName)
 	printErr(err)
 	err = testVdb.UploadFile(ctx, database, collectionName, localFilePath)
 	printErr(err)
 	err = testVdb.QueryData(ctx, database, collectionName, filename)
 	printErr(err)
-	err = testVdb.DeleteAndDrop(ctx, database, collectionName)
-	printErr(err)
+
 }

tcvectordb/api/document/api.go

@@ -313,3 +313,25 @@ type ImageInfo struct {
 	ImageName  string `json:"imageName"`
 	ImageUrl   string `json:"imageUrl"`
 }
+
+type QueryFileDetailsReq struct {
+	api.Meta        `path:"/ai/document/queryFileDetails" tags:"Document" method:"Post" summary:"查询文件详情"`
+	Database        string                `json:"database"`
+	Collection      string                `json:"collection"`
+	ReadConsistency string                `json:"readConsistency,omitempty"`
+	Query           *QueryFileDetailsCond `json:"query,omitempty"`
+}
+
+type QueryFileDetailsCond struct {
+	FileNames    []string `json:"fileNames,omitempty"`
+	Filter       string   `json:"filter,omitempty"`
+	Limit        *int64   `json:"limit,omitempty"`
+	Offset       int64    `json:"offset,omitempty"`
+	OutputFields []string `json:"outputFields,omitempty"`
+}
+
+type QueryFileDetailsRes struct {
+	api.CommonRes
+	Count     uint64      `json:"count"`
+	Documents []*Document `json:"documents"`
+}

tcvectordb/base_flat.go

@@ -97,6 +97,9 @@ type FlatInterface interface {
 
 	GetImageUrl(ctx context.Context, databaseName, collectionName string,
 		param GetImageUrlParams) (result *GetImageUrlResult, err error)
+
+	QueryFileDetails(ctx context.Context, databaseName, collectionName string,
+		param *QueryFileDetailsParams) (result *QueryFileDetailsResult, err error)
 }
 
 // [CreateUserParams] holds the parameters for creating the user.
@@ -557,3 +560,64 @@ func getImageUrl(ctx context.Context, cli SdkClient, databaseName, collectionNam
 	result.Images = res.Images
 	return result, nil
 }
+
+type QueryFileDetailsParams struct {
+	FileNames    []string
+	Filter       *Filter
+	Limit        *int64
+	Offset       int64
+	OutputFields []string
+}
+
+type QueryFileDetailsResult struct {
+	Documents []Document
+	Count     uint64
+}
+
+func (i *implementerFlatDocument) QueryFileDetails(ctx context.Context, databaseName, collectionName string,
+	param *QueryFileDetailsParams) (result *QueryFileDetailsResult, err error) {
+	return queryFileDetails(ctx, i.SdkClient, databaseName, collectionName, param)
+}
+
+func queryFileDetails(ctx context.Context, cli SdkClient, databaseName, collectionName string,
+	param *QueryFileDetailsParams) (result *QueryFileDetailsResult, err error) {
+	req := new(document.QueryFileDetailsReq)
+	req.Database = databaseName
+	req.Collection = collectionName
+	if param != nil {
+		req.Query = new(document.QueryFileDetailsCond)
+		req.Query.FileNames = param.FileNames
+		if param.Filter != nil {
+			req.Query.Filter = param.Filter.Cond()
+		}
+		if param.Limit != nil {
+			req.Query.Limit = param.Limit
+		}
+		req.Query.Offset = param.Offset
+		req.Query.OutputFields = param.OutputFields
+	}
+
+	res := new(document.QueryFileDetailsRes)
+	err = cli.Request(ctx, req, res)
+	if err != nil {
+		return nil, err
+	}
+
+	result = new(QueryFileDetailsResult)
+	result.Count = res.Count
+
+	result.Documents = make([]Document, len(res.Documents))
+
+	for index, doc := range res.Documents {
+		var d Document
+		d.Id = doc.Id
+		d.Fields = make(map[string]Field)
+
+		for n, v := range doc.Fields {
+			d.Fields[n] = Field{Val: v}
+		}
+		result.Documents[index] = d
+	}
+
+	return result, nil
+}

tcvectordb/rpc_base_document.go

@@ -973,3 +973,8 @@ func (r *rpcImplementerFlatDocument) UploadFile(ctx context.Context, databaseNam
 func (r *rpcImplementerFlatDocument) GetImageUrl(ctx context.Context, databaseName, collectionName string, param GetImageUrlParams) (result *GetImageUrlResult, err error) {
 	return getImageUrl(ctx, r.SdkClient, databaseName, collectionName, param)
 }
+
+func (r *rpcImplementerFlatDocument) QueryFileDetails(ctx context.Context, databaseName, collectionName string,
+	param *QueryFileDetailsParams) (result *QueryFileDetailsResult, err error) {
+	return queryFileDetails(ctx, r.SdkClient, databaseName, collectionName, param)
+}

tcvectordb/version.go

@@ -18,4 +18,4 @@
 
 package tcvectordb
 
-const SDKVersion = "v1.7.1"
+const SDKVersion = "v1.7.2"