Skip to content

Commit dadffec

Browse files
Merge pull request #994 from milvus-io/update-sdk-anthony
update docs
2 parents 6578742 + 62297bb commit dadffec

File tree

5 files changed

+85
-85
lines changed

5 files changed

+85
-85
lines changed

API_Reference/milvus-sdk-go/v2.5.x/Collection/CreateCollection.md

+41-41
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,15 @@ func NewCreateCollectionOption(name string, collectionSchema *entity.Schema) *cr
6565

6666
You can chain the following methods to append more parameters to the `createCollectionOption` struct.
6767

68-
- [WithShardNum](CreateCollection.md#withshardnum)
68+
- [WithShardNum](CreateCollection.md#WithShardNum)
6969

70-
- [WithIndexOptions](CreateCollection.md#withindexoptions)
70+
- [WithIndexOptions](CreateCollection.md#WithIndexOptions)
7171

72-
- [WithProperty](CreateCollection.md#withproperty)
72+
- [WithProperty](CreateCollection.md#WithProperty)
7373

74-
- [WithConsistencyLevel](CreateCollection.md#withconsistencylevel)
74+
- [WithConsistencyLevel](CreateCollection.md#WithConsistencyLevel)
7575

76-
- [WithIndexOptions](CreateCollection.md#withindexoptions)
76+
- [WithIndexOptions](CreateCollection.md#WithIndexOptions)
7777

7878
### SimpleCreateCollectionOptions
7979

@@ -103,13 +103,13 @@ func SimpleCreateCollectionOptions(name string, dim int64) *createCollectionOpti
103103

104104
You can chain the following methods to append more parameters to the `createCollectionOption` struct.
105105

106-
- [WithAutoID](CreateCollection.md#withautoid)
106+
- [WithAutoID](CreateCollection.md#WithAutoID)
107107

108-
- [WithDynamicSchema](CreateCollection.md#withdynamicschema)
108+
- [WithDynamicSchema](CreateCollection.md#WithDynamicSchema)
109109

110-
- [WithVarcharPK](CreateCollection.md#withvarcharpk)
110+
- [WithVarcharPK](CreateCollection.md#WithVarcharPK)
111111

112-
- [WithIndexOptions](CreateCollection.md#withindexoptions)
112+
- [WithIndexOptions](CreateCollection.md#WithIndexOptions)
113113

114114
### WithAutoID
115115

@@ -271,17 +271,17 @@ You can use the `entity.NewSchema` method to get the concrete implementation of
271271

272272
This method creates an empty schema. You can chain the following methods to append corresponding parameters to the created schema.
273273

274-
- [WithAutoID](CreateCollection.md#entitywithautoid)
274+
- [WithAutoID](CreateCollection.md#WithAutoID)
275275

276-
- [WithDescription](CreateCollection.md#entitywithdescription)
276+
- [WithDescription](CreateCollection.md#WithDescription)
277277

278-
- [WithDynamicFieldEnabled](CreateCollection.md#entitywithdynamicfieldenabled)
278+
- [WithDynamicFieldEnabled](CreateCollection.md#WithDynamicFieldEnabled)
279279

280-
- [WithField](CreateCollection.md#entitywithfield)
280+
- [WithField](CreateCollection.md#WithField)
281281

282-
- [WithFunction](CreateCollection.md#entitywithfunction)
282+
- [WithFunction](CreateCollection.md#WithFunction)
283283

284-
- [WithName](CreateCollection.md#entitywithname)
284+
- [WithName](CreateCollection.md#WithName)
285285

286286
### entity.WithAutoID
287287

@@ -417,49 +417,49 @@ You can use the `entity.NewField` method to get the concrete implementation of t
417417

418418
This method creates an empty field schema. You can chain the following methods to append corresponding parameters to the created field schema.
419419

420-
- [WithAnalyzerParams](CreateCollection.md#entitywithanalyzerparams)
420+
- [WithAnalyzerParams](CreateCollection.md#WithAnalyzerParams)
421421

422-
- [WithDataType](CreateCollection.md#entitywithdatatype)
422+
- [WithDataType](CreateCollection.md#WithDataType)
423423

424-
- [WithDefaultValueBool](CreateCollection.md#entitywithdefaultvaluebool)
424+
- [WithDefaultValueBool](CreateCollection.md#WithDefaultValueBool)
425425

426-
- [WithDefaultValueDouble](CreateCollection.md#entitywithdefaultvaluedouble)
426+
- [WithDefaultValueDouble](CreateCollection.md#WithDefaultValueDouble)
427427

428-
- [WithDefaultValueFloat](CreateCollection.md#entitywithdefaultvaluefloat)
428+
- [WithDefaultValueFloat](CreateCollection.md#WithDefaultValueFloat)
429429

430-
- [WithDefaultValueInt](CreateCollection.md#entitywithdefaultvalueint)
430+
- [WithDefaultValueInt](CreateCollection.md#WithDefaultValueInt)
431431

432-
- [WithDefaultValueLong](CreateCollection.md#entitywithdefaultvaluelong)
432+
- [WithDefaultValueLong](CreateCollection.md#WithDefaultValueLong)
433433

434-
- [WithDefaultValueString](CreateCollection.md#entitywithdefaultvaluestring)
434+
- [WithDefaultValueString](CreateCollection.md#WithDefaultValueString)
435435

436-
- [WithDescription](CreateCollection.md#entitywithdescription)
436+
- [WithDescription](CreateCollection.md#WithDescription)
437437

438-
- [WithDim](CreateCollection.md#entitydim)
438+
- [WithDim](CreateCollection.md#WithDim)
439439

440-
- [WithElementType](CreateCollection.md#entitywithelementtype)
440+
- [WithElementType](CreateCollection.md#WithElementType)
441441

442-
- [WithEnableAnalyzer](CreateCollection.md#entitywithenableanalyzer)
442+
- [WithEnableAnalyzer](CreateCollection.md#WithEnableAnalyzer)
443443

444-
- [WithIsAutoID](CreateCollection.md#entitywithisautoid)
444+
- [WithIsAutoID](CreateCollection.md#WithIsAutoID)
445445

446-
- [WithIsClusteringKey](CreateCollection.md#entitywithisclusteringkey)
446+
- [WithIsClusteringKey](CreateCollection.md#WithIsClusteringKey)
447447

448-
- [WithIsDynamic](CreateCollection.md#entitywithisdynamic)
448+
- [WithIsDynamic](CreateCollection.md#WithIsDynamic)
449449

450-
- [WithIsPartitionKey](CreateCollection.md#entitywithispartitionkey)
450+
- [WithIsPartitionKey](CreateCollection.md#WithIsPartitionKey)
451451

452-
- [WithIsPrimaryKey](CreateCollection.md#entitywithisprimarykey)
452+
- [WithIsPrimaryKey](CreateCollection.md#WithIsPrimaryKey)
453453

454-
- [WithMaxCapacity](CreateCollection.md#entitywithmaxcapacity)
454+
- [WithMaxCapacity](CreateCollection.md#WithMaxCapacity)
455455

456-
- [WithMaxLength](CreateCollection.md#entitywithmaxlength)
456+
- [WithMaxLength](CreateCollection.md#WithMaxLength)
457457

458-
- [WithName](CreateCollection.md#entitywithname)
458+
- [WithName](CreateCollection.md#WithName)
459459

460-
- [WithNullable](CreateCollection.md#entitywithnullable)
460+
- [WithNullable](CreateCollection.md#WithNullable)
461461

462-
- [WithTypeParams](CreateCollection.md#entitywithtypeparams)
462+
- [WithTypeParams](CreateCollection.md#WithTypeParams)
463463

464464
### entity.WithAnalyzerParams
465465

@@ -944,13 +944,13 @@ You can use the `entity.NewFunction` method to get the concrete implementation o
944944

945945
This method creates an empty function. You can chain the following methods to append corresponding parameters to the created field schema.
946946

947-
- [WithInputFields](CreateCollection.md#entitywithinputfields)
947+
- [WithInputFields](CreateCollection.md#WithInputFields)
948948

949-
- [WithName](CreateCollection.md#entityname)
949+
- [WithName](CreateCollection.md#WithName)
950950

951-
- [WithOutputFields](CreateCollection.md#entitywithoutputfields)
951+
- [WithOutputFields](CreateCollection.md#WithOutputFields)
952952

953-
- [WithParam](CreateCollection.md#entitywithparam)
953+
- [WithParam](CreateCollection.md#WithParam)
954954

955955
- WithType
956956

API_Reference/milvus-sdk-go/v2.5.x/Collection/DescribeCollection.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,11 @@ type Collection struct {
7878

7979
## entity.Schema
8080

81-
For details about this struct type, refer to [entity.Schema](CreateCollection.md#entityschema).
81+
For details about this struct type, refer to [entity.Schema](CreateCollection.md#entity.Schema).
8282

8383
## entity.ConsistencyLevel
8484

85-
For details about this enumeration, refer to [entity.ConsistencyLevel](CreateCollection.md#entityconsistencylevel).
85+
For details about this enumeration, refer to [entity.ConsistencyLevel](CreateCollection.md#entity.ConsistencyLevel).
8686

8787
## Return
8888

API_Reference/milvus-sdk-go/v2.5.x/Management/DescribeIndex.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ type IndexDescription struct {
7979

8080
## index.Index
8181

82-
This is an interface type. For details, refer to [index.Index](CreateIndex.md#indexindex).
82+
This is an interface type. For details, refer to [index.Index](CreateIndex.md#index.Index).
8383

8484
## index.IndexState
8585

API_Reference/milvus-sdk-go/v2.5.x/Vector/Insert.md

+36-36
Original file line numberDiff line numberDiff line change
@@ -91,29 +91,29 @@ func NewColumnBasedInsertOption(collName string, columns ...column.Column) *colu
9191

9292
You can chain the following method to get an implementation of the `columnBasedDataOption` struct.
9393

94-
- [WithColumns](Insert.md#withcolumns)
94+
- [WithColumns](Insert.md#WithColumns)
9595

96-
- [WithBoolColumn](Insert.md#withboolcolumn)
96+
- [WithBoolColumn](Insert.md#WithBoolColumn)
9797

98-
- [WithInt8Column](Insert.md#withint8column)
98+
- [WithInt8Column](Insert.md#WithInt8Column)
9999

100-
- [WithInt16Column](Insert.md#withint16column)
100+
- [WithInt16Column](Insert.md#WithInt16Column)
101101

102-
- [WithInt32Column](Insert.md#withint32column)
102+
- [WithInt32Column](Insert.md#WithInt32Column)
103103

104-
- [WithInt64Column](Insert.md#withint64column)
104+
- [WithInt64Column](Insert.md#WithInt64Column)
105105

106-
- [WithVarcharColumn](Insert.md#withvarcharcolumn)
106+
- [WithVarcharColumn](Insert.md#WithVarcharColumn)
107107

108-
- [WithFloatVectorColumn](Insert.md#withfloatvectorcolumn)
108+
- [WithFloatVectorColumn](Insert.md#WithFloatVectorColumn)
109109

110-
- [WithFloat16VectorColumn](Insert.md#withfloat16vectorcolumn)
110+
- [WithFloat16VectorColumn](Insert.md#WithFloat16VectorColumn)
111111

112-
- [WithBFloat16VectorColumn](Insert.md#withbfloat16vectorcolumn)
112+
- [WithBFloat16VectorColumn](Insert.md#WithBFloat16VectorColumn)
113113

114-
- [WithBinaryVectorColumn](Insert.md#withbinaryvectorcolumn)
114+
- [WithBinaryVectorColumn](Insert.md#WithBinaryVectorColumn)
115115

116-
- [WithPartition](Insert.md#withpartition)
116+
- [WithPartition](Insert.md#WithPartition)
117117

118118
### WithColumns
119119

@@ -441,51 +441,51 @@ func (opt *columnBasedDataOption) WithPartition(partitionName string) *columnBas
441441

442442
This is an interface type. The following struct types implement this interface type.
443443

444-
- [column.ColumnBFloat16Vector](Insert.md#columncolumnbfloat16vector)
444+
- [column.ColumnBFloat16Vector](Insert.md#column.ColumnBFloat16Vector)
445445

446-
- [column.ColumnBinaryVector](Insert.md#columncolumnbinaryvector)
446+
- [column.ColumnBinaryVector](Insert.md#column.ColumnBinaryVector)
447447

448-
- [column.ColumnBool](Insert.md#columncolumnbool)
448+
- [column.ColumnBool](Insert.md#column.ColumnBool)
449449

450-
- [column.ColumnBoolArray](Insert.md#columncolumnboolarray)
450+
- [column.ColumnBoolArray](Insert.md#column.ColumnBoolArray)
451451

452-
- [column.ColumnDouble](Insert.md#columncolumndouble)
452+
- [column.ColumnDouble](Insert.md#column.ColumnDouble)
453453

454-
- [column.ColumnDoubleArray](Insert.md#columncolumndoublearray)
454+
- [column.ColumnDoubleArray](Insert.md#column.ColumnDoubleArray)
455455

456-
- [column.ColumnDynamic](Insert.md#columncolumndynamic)
456+
- [column.ColumnDynamic](Insert.md#column.ColumnDynamic)
457457

458-
- [column.ColumnFloat](Insert.md#columncolumnfloat)
458+
- [column.ColumnFloat](Insert.md#column.ColumnFloat)
459459

460-
- [column.ColumnFloat16Vector](Insert.md#columncolumnfloat16vector)
460+
- [column.ColumnFloat16Vector](Insert.md#column.ColumnFloat16Vector)
461461

462-
- [column.ColumnFloatArray](Insert.md#columncolumnfloatarray)
462+
- [column.ColumnFloatArray](Insert.md#column.ColumnFloatArray)
463463

464-
- [column.ColumnFloatVector](Insert.md#columncolumnfloatvector)
464+
- [column.ColumnFloatVector](Insert.md#column.ColumnFloatVector)
465465

466-
- [column.ColumnInt16](Insert.md#columncolumnint16)
466+
- [column.ColumnInt16](Insert.md#column.ColumnInt16)
467467

468-
- [column.ColumnInt16Array](Insert.md#columncolumnint16array)
468+
- [column.ColumnInt16Array](Insert.md#column.ColumnInt16Array)
469469

470-
- [column.ColumnInt32](Insert.md#columncolumnint32)
470+
- [column.ColumnInt32](Insert.md#column.ColumnInt32)
471471

472-
- [column.ColumnInt32Array](Insert.md#columncolumnint32array)
472+
- [column.ColumnInt32Array](Insert.md#column.ColumnInt32Array)
473473

474-
- [column.ColumnInt64](Insert.md#columncolumnint64)
474+
- [column.ColumnInt64](Insert.md#column.ColumnInt64)
475475

476-
- [column.ColumnInt64Array](Insert.md#columncolumnint64array)
476+
- [column.ColumnInt64Array](Insert.md#column.ColumnInt64Array)
477477

478-
- [column.ColumnInt8](Insert.md#columncolumnint8)
478+
- [column.ColumnInt8](Insert.md#column.ColumnInt8)
479479

480-
- [column.ColumnInt8Array](Insert.md#columncolumnint8array)
480+
- [column.ColumnInt8Array](Insert.md#column.ColumnInt8Array)
481481

482-
- [column.ColumnJSONBytes](Insert.md#columncolumnjsonbytes)
482+
- [column.ColumnJSONBytes](Insert.md#column.ColumnJSONBytes)
483483

484-
- [column.ColumnSparseFloatVector](Insert.md#columncolumnsparsefloatvector)
484+
- [column.ColumnSparseFloatVector](Insert.md#column.ColumnSparseFloatVector)
485485

486-
- [column.ColumnVarChar](Insert.md#columncolumnvarchar)
486+
- [column.ColumnVarChar](Insert.md#column.ColumnVarChar)
487487

488-
- [column.ColumnVarCharArray](Insert.md#columncolumnvarchararray)
488+
- [column.ColumnVarCharArray](Insert.md#column.ColumnVarCharArray)
489489

490490
## column.ColumnBFloat16Vector
491491

@@ -1294,7 +1294,7 @@ func NewNullableColumnCreator[col interface {
12941294

12951295
You can chain the following methods to get a nullable column.
12961296

1297-
- [New()](Insert.md#new)
1297+
- [New()](Insert.md#New())
12981298

12991299
### New
13001300

API_Reference/milvus-sdk-go/v2.5.x/Vector/Search.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,15 @@ func NewSearchOption(collectionName string, limit int, vectors []entity.Vector)
7272

7373
This is an interface. The following types implement this interface.
7474

75-
- [entity.FloatVector](Search.md#entityfloatvector)
75+
- [entity.FloatVector](Search.md#entity.FloatVector)
7676

77-
- [entity.Float16Vector](Search.md#entityfloat16vector)
77+
- [entity.Float16Vector](Search.md#entity.Float16Vector)
7878

79-
- [entity.BFloat16Vector](Search.md#entitybfloat16vector)
79+
- [entity.BFloat16Vector](Search.md#entity.BFloat16Vector)
8080

81-
- [entity.BinaryVector](Search.md#entitybinaryvector)
81+
- [entity.BinaryVector](Search.md#entity.BinaryVector)
8282

83-
- [entity.Text](Search.md#entitytext)
83+
- [entity.Text](Search.md#entity.Text)
8484

8585
## entity.FloatVector
8686

0 commit comments

Comments
 (0)