doc: add comments

Author: averiewang

example/collection_upload_file_demo/main.go

@@ -16,11 +16,11 @@ import (
 )
 
 type Demo struct {
-	client *tcvectordb.Client
+	client *tcvectordb.RpcClient
 }
 
 func NewDemo(url, username, key string) (*Demo, error) {
-	cli, err := tcvectordb.NewClient(url, username, key, &tcvectordb.ClientOption{
+	cli, err := tcvectordb.NewRpcClient(url, username, key, &tcvectordb.ClientOption{
 		ReadConsistency: tcvectordb.StrongConsistency})
 	if err != nil {
 		return nil, err
@@ -275,23 +275,22 @@ func printErr(err error) {
 }
 
 func main() {
-	database := "test-db"
-	collectionName := "test-coll"
+	database := "go-sdk-demo-db"
+	collectionName := "go-sdk-demo-col-test"
 
 	_, filePath, _, _ := runtime.Caller(0)
-	localFilePath := path.Join(path.Dir(filePath), "../demo_files/tcvdb.md")
+	localFilePath := path.Join(path.Dir(filePath), "../demo_files/tcvdb.pdf")
 	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)
 }

example/modify_vector_index/main.go

@@ -231,6 +231,7 @@ func (d *Demo) ModifyVectorIndex(ctx context.Context, database, collection strin
 	param.VectorIndexes = make([]tcvectordb.ModifyVectorIndex, 0)
 	param.VectorIndexes = append(param.VectorIndexes, tcvectordb.ModifyVectorIndex{
 		FieldName:  "vector",
+		FieldType:  "bfloat16_vector",
 		MetricType: tcvectordb.COSINE,
 		Params: &tcvectordb.HNSWParam{
 			M:              8,

tcvectordb/ai_collection_view.go

@@ -158,11 +158,11 @@ func (i *implementerCollectionView) CreateCollectionView(ctx context.Context, na
 	req.Description = param.Description
 
 	for _, v := range param.Indexes.FilterIndex {
-		var column api.IndexColumn
+		column := new(api.IndexColumn)
 		column.FieldName = v.FieldName
 		column.FieldType = string(v.FieldType)
 		column.IndexType = string(v.IndexType)
-		req.Indexes = append(req.Indexes, &column)
+		req.Indexes = append(req.Indexes, column)
 	}
 
 	if param.Embedding != nil {

tcvectordb/base_collection.go

@@ -174,38 +174,38 @@ func (i *implementerCollection) CreateCollection(ctx context.Context, name strin
 	req.Description = description
 
 	for _, v := range indexes.VectorIndex {
-		var column api.IndexColumn
+		column := new(api.IndexColumn)
 		column.FieldName = v.FieldName
 		column.FieldType = string(v.FieldType)
 		column.IndexType = string(v.IndexType)
 		column.MetricType = string(v.MetricType)
 		column.Dimension = v.Dimension
 
-		optionParams(&column, v)
+		optionParams(column, v)
 
-		req.Indexes = append(req.Indexes, &column)
+		req.Indexes = append(req.Indexes, column)
 	}
 
 	for _, v := range indexes.SparseVectorIndex {
-		var column api.IndexColumn
+		column := new(api.IndexColumn)
 		column.FieldName = v.FieldName
 		column.FieldType = string(v.FieldType)
 		column.IndexType = string(v.IndexType)
 		column.MetricType = string(v.MetricType)
 
-		req.Indexes = append(req.Indexes, &column)
+		req.Indexes = append(req.Indexes, column)
 	}
 
 	for _, v := range indexes.FilterIndex {
-		var column api.IndexColumn
+		column := new(api.IndexColumn)
 		column.FieldName = v.FieldName
 		column.FieldType = string(v.FieldType)
 		if v.FieldType == Array {
 			column.FieldElementType = string(v.ElemType)
 		}
 		column.IndexType = string(v.IndexType)
 		column.AutoId = v.AutoId
-		req.Indexes = append(req.Indexes, &column)
+		req.Indexes = append(req.Indexes, column)
 	}
 	if len(params) != 0 && params[0] != nil {
 		param := params[0]
@@ -462,7 +462,7 @@ func (i *implementerCollection) toCollection(collectionItem *collection.Describe
 			continue
 		}
 		switch index.FieldType {
-		case string(Vector):
+		case string(Vector), string(BinaryVector), string(BFloat16Vector), string(Float16Vector):
 			vector := VectorIndex{}
 			vector.FieldName = index.FieldName
 			vector.FieldType = FieldType(index.FieldType)

tcvectordb/base_flat.go

@@ -93,11 +93,15 @@ type FlatInterface interface {
 	// [ChangePassword] changes the password for the specific user.
 	ChangePassword(ctx context.Context, param ChangePasswordParams) error
 
-	UploadFile(ctx context.Context, databaseName, collectionName string, param UploadFileParams) (result *UploadFileResult, err error)
+	// [UploadFile] uploads a file to the collection.
+	UploadFile(ctx context.Context, databaseName, collectionName string,
+		param UploadFileParams) (result *UploadFileResult, err error)
 
+	// [GetImageUrl] retrieves image URLs for the specified file and documents in the collection.
 	GetImageUrl(ctx context.Context, databaseName, collectionName string,
 		param GetImageUrlParams) (result *GetImageUrlResult, err error)
 
+	// [QueryFileDetails] queries file details from the collection.
 	QueryFileDetails(ctx context.Context, databaseName, collectionName string,
 		param *QueryFileDetailsParams) (result *QueryFileDetailsResult, err error)
 }
@@ -528,15 +532,35 @@ func uploadFile(ctx context.Context, cli SdkClient, databaseName, collectionName
 	return result, nil
 }
 
+// [GetImageUrlParams] holds the parameters for getting image URLs.
+//
+// Fields:
+//   - FileName: The name of the file to get image URLs for.
+//   - DocumentIds: The list of document IDs to get image URLs for.
 type GetImageUrlParams struct {
 	FileName    string
 	DocumentIds []string
 }
 
+// [GetImageUrlResult] holds the results for getting image URLs.
+//
+// Fields:
+//   - Images: A two-dimensional array of image information, where each inner array contains image details for a document.
 type GetImageUrlResult struct {
 	Images [][]document.ImageInfo
 }
 
+// [GetImageUrl] retrieves image URLs for the specified file and documents in the collection.
+//
+// Parameters:
+//   - ctx: A context.Context object controls the request's lifetime, allowing for the request
+//     to be canceled or to timeout according to the context's deadline.
+//   - databaseName: The name of the database.
+//   - collectionName: The name of the collection.
+//   - param: A [GetImageUrlParams] object that includes the other parameters for getting image URLs operation.
+//     See [GetImageUrlParams] for more information.
+//
+// Returns a pointer to a [GetImageUrlResult] object or an error.
 func (i *implementerFlatDocument) GetImageUrl(ctx context.Context, databaseName, collectionName string,
 	param GetImageUrlParams) (result *GetImageUrlResult, err error) {
 	return getImageUrl(ctx, i.SdkClient, databaseName, collectionName, param)
@@ -561,6 +585,14 @@ func getImageUrl(ctx context.Context, cli SdkClient, databaseName, collectionNam
 	return result, nil
 }
 
+// [QueryFileDetailsParams] holds the parameters for querying file details.
+//
+// Fields:
+//   - FileNames: The list of file names to query details for.
+//   - Filter: A pointer to a Filter object for filtering the query results.
+//   - Limit: A pointer to the maximum number of results to return. If nil, default limit is 10.
+//   - Offset: The pagination offset to control the starting position of results returned by the paginated query.
+//   - OutputFields: The list of fields to include in the output results.
 type QueryFileDetailsParams struct {
 	FileNames    []string
 	Filter       *Filter
@@ -569,11 +601,27 @@ type QueryFileDetailsParams struct {
 	OutputFields []string
 }
 
+// [QueryFileDetailsResult] holds the results for querying file details.
+//
+// Fields:
+//   - Documents: The list of documents that match the query conditions.
+//   - Count: The total number of documents that match the query conditions.
 type QueryFileDetailsResult struct {
 	Documents []Document
 	Count     uint64
 }
 
+// [QueryFileDetails] queries file details based on the specified query conditions from the collection.
+//
+// Parameters:
+//   - ctx: A context.Context object controls the request's lifetime, allowing for the request
+//     to be canceled or to timeout according to the context's deadline.
+//   - databaseName: The name of the database.
+//   - collectionName: The name of the collection.
+//   - param: A pointer to a [QueryFileDetailsParams] object that includes the other parameters for querying file details operation.
+//     See [QueryFileDetailsParams] for more information.
+//
+// Returns a pointer to a [QueryFileDetailsResult] object or an error.
 func (i *implementerFlatDocument) QueryFileDetails(ctx context.Context, databaseName, collectionName string,
 	param *QueryFileDetailsParams) (result *QueryFileDetailsResult, err error) {
 	return queryFileDetails(ctx, i.SdkClient, databaseName, collectionName, param)

tcvectordb/base_index_flat.go

@@ -57,11 +57,23 @@ type AddIndexParams struct {
 	BuildExistedData *bool
 }
 
+// [ModifyVectorIndexParam] holds the parameters for modifying vector indexes in a collection.
+//
+// Fields:
+//   - VectorIndexes: The list of vector indexes to be modified.
+//   - RebuildRules: A pointer to [RebuildRules] object that specifies the rules for rebuilding indexes.
 type ModifyVectorIndexParam struct {
 	VectorIndexes []ModifyVectorIndex
 	RebuildRules  *index.RebuildRules
 }
 
+// [ModifyVectorIndex] represents a vector index configuration for modification.
+//
+// Fields:
+//   - FieldName: The name of the field for the vector index.
+//   - FieldType: The type of the field (e.g., "vector", "float16_vector", "bfloat16_vector").
+//   - MetricType: The metric type used for similarity calculation (e.g., COSINE, L2).
+//   - Params: The index parameters that specify the configuration details for the index.
 type ModifyVectorIndex struct {
 	FieldName  string
 	FieldType  string
@@ -158,20 +170,30 @@ func (i *implementerFlatIndex) DropIndex(ctx context.Context, databaseName, coll
 }
 
 // [ModifyVectorIndex] modifies vector indexes to an existing collection.
+//
+// Parameters:
+//   - ctx: A context.Context object controls the request's lifetime, allowing for the request
+//     to be canceled or to timeout according to the context's deadline.
+//   - databaseName: The name of the database.
+//   - collectionName: The name of the collection.
+//   - param: A [ModifyVectorIndexParam] object that includes the parameters for modifying vector indexes operation.
+//     See [ModifyVectorIndexParam] for more information.
+//
+// Returns an error if the modification fails.
 func (i *implementerFlatIndex) ModifyVectorIndex(ctx context.Context, databaseName, collectionName string, param ModifyVectorIndexParam) error {
 	req := new(index.ModifyVectorIndexReq)
 	req.Database = databaseName
 	req.Collection = collectionName
 
 	for _, v := range param.VectorIndexes {
-		var column api.IndexColumn
+		column := new(api.IndexColumn)
 		column.FieldName = v.FieldName
 		column.FieldType = v.FieldType
 		column.MetricType = string(v.MetricType)
 
-		optionParamsFromIndexParams(&column, v.Params)
+		optionParamsFromIndexParams(column, v.Params)
 
-		req.VectorIndexes = append(req.VectorIndexes, &column)
+		req.VectorIndexes = append(req.VectorIndexes, column)
 	}
 	req.RebuildRules = param.RebuildRules
 

tcvectordb/rpc_base_collection.go

@@ -386,7 +386,7 @@ func (r *rpcImplementerCollection) toCollection(collectionItem *olama.CreateColl
 			continue
 		}
 		switch index.FieldType {
-		case string(Vector), string(BinaryVector):
+		case string(Vector), string(BinaryVector), string(BFloat16Vector), string(Float16Vector):
 			vector := VectorIndex{}
 			vector.FieldName = index.FieldName
 			vector.FieldType = FieldType(index.FieldType)

tcvectordb/rpc_base_document.go

@@ -966,14 +966,47 @@ func (r *rpcImplementerFlatDocument) Count(ctx context.Context, databaseName, co
 	return &CountDocumentResult{Count: res.Count}, nil
 }
 
+// [UploadFile] uploads a file to the collection.
+//
+// Parameters:
+//   - ctx: A context.Context object controls the request's lifetime, allowing for the request
+//     to be canceled or to timeout according to the context's deadline.
+//   - databaseName: The name of the database.
+//   - collectionName: The name of the collection.
+//   - param: A [UploadFileParams] object that includes the other parameters for uploading file operation.
+//     See [UploadFileParams] for more information.
+//
+// Returns a pointer to a [UploadFileResult] object or an error.
 func (r *rpcImplementerFlatDocument) UploadFile(ctx context.Context, databaseName, collectionName string, param UploadFileParams) (result *UploadFileResult, err error) {
 	return uploadFile(ctx, r.SdkClient, databaseName, collectionName, param)
 }
 
+// [GetImageUrl] retrieves image URLs for the specified file and documents in the collection.
+//
+// Parameters:
+//   - ctx: A context.Context object controls the request's lifetime, allowing for the request
+//     to be canceled or to timeout according to the context's deadline.
+//   - databaseName: The name of the database.
+//   - collectionName: The name of the collection.
+//   - param: A [GetImageUrlParams] object that includes the other parameters for getting image URLs operation.
+//     See [GetImageUrlParams] for more information.
+//
+// Returns a pointer to a [GetImageUrlResult] object or an error.
 func (r *rpcImplementerFlatDocument) GetImageUrl(ctx context.Context, databaseName, collectionName string, param GetImageUrlParams) (result *GetImageUrlResult, err error) {
 	return getImageUrl(ctx, r.SdkClient, databaseName, collectionName, param)
 }
 
+// [QueryFileDetails] queries file details based on the specified query conditions from the collection.
+//
+// Parameters:
+//   - ctx: A context.Context object controls the request's lifetime, allowing for the request
+//     to be canceled or to timeout according to the context's deadline.
+//   - databaseName: The name of the database.
+//   - collectionName: The name of the collection.
+//   - param: A pointer to a [QueryFileDetailsParams] object that includes the other parameters for querying file details operation.
+//     See [QueryFileDetailsParams] for more information.
+//
+// Returns a pointer to a [QueryFileDetailsResult] object or an error.
 func (r *rpcImplementerFlatDocument) QueryFileDetails(ctx context.Context, databaseName, collectionName string,
 	param *QueryFileDetailsParams) (result *QueryFileDetailsResult, err error) {
 	return queryFileDetails(ctx, r.SdkClient, databaseName, collectionName, param)