Skip to content

Commit 726c64c

Browse files
shanghaikidclaude
andcommitted
docs: update README with new APIs and advanced features links
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: ryjiang <jiangruiyi@gmail.com>
1 parent f302f93 commit 726c64c

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,26 @@ for await (const batch of iterator) {
310310
}
311311
```
312312

313+
#### hybridSearch
314+
315+
Multi-vector search combining results from multiple vector fields with reranking.
316+
317+
```typescript
318+
const results = await client.hybridSearch({
319+
collection_name: string;
320+
rerank: WeightedReranker | RRFReranker; // Reranking strategy
321+
requests: Array<{
322+
data: number[][];
323+
anns_field: string;
324+
params?: Record<string, any>;
325+
limit?: number;
326+
filter?: string;
327+
}>;
328+
limit: number;
329+
output_fields?: string[];
330+
});
331+
```
332+
313333
---
314334

315335
### Collection Management
@@ -333,14 +353,21 @@ await client.createCollection({
333353
```typescript
334354
await client.hasCollection({ collection_name }); // { value: boolean }
335355
await client.describeCollection({ collection_name }); // Schema, fields, properties
356+
await client.batchDescribeCollections({ collection_names: string[] }); // Describe multiple collections
336357
await client.showCollections(); // List all collections
337358
await client.loadCollection({ collection_name }); // Load into memory
338359
await client.releaseCollection({ collection_name }); // Release from memory
360+
await client.refreshLoad({ collection_name }); // Refresh loaded collection
339361
await client.dropCollection({ collection_name }); // Delete collection
340362
await client.renameCollection({ collection_name, new_collection_name });
341363
await client.truncateCollection({ collection_name }); // Clear all data
342364
await client.getLoadState({ collection_name }); // Loading status
343365
await client.getCollectionStatistics({ collection_name });
366+
await client.alterCollectionProperties({ collection_name, properties });
367+
await client.alterCollectionFieldProperties({ collection_name, field_name, properties });
368+
await client.dropCollectionProperties({ collection_name, delete_keys: string[] });
369+
await client.addCollectionFunction({ collection_name, functions });
370+
await client.dropCollectionFunction({ collection_name, functions });
344371
```
345372

346373
---
@@ -361,9 +388,12 @@ await client.createIndex({
361388
// Other index operations
362389
await client.describeIndex({ collection_name, field_name? });
363390
await client.listIndexes({ collection_name });
391+
await client.getIndexStatistics({ collection_name, index_name? });
364392
await client.dropIndex({ collection_name, field_name, index_name? });
365393
await client.getIndexState({ collection_name, field_name? });
366394
await client.getIndexBuildProgress({ collection_name, field_name? });
395+
await client.alterIndexProperties({ collection_name, index_name, properties });
396+
await client.dropIndexProperties({ collection_name, index_name, delete_keys: string[] });
367397
```
368398

369399
---
@@ -387,6 +417,8 @@ await client.dropPartition({ collection_name, partition_name });
387417
await client.createDatabase({ db_name });
388418
await client.listDatabases();
389419
await client.describeDatabase({ db_name });
420+
await client.alterDatabaseProperties({ db_name, properties });
421+
await client.dropDatabaseProperties({ db_name, delete_keys: string[] });
390422
await client.dropDatabase({ db_name });
391423
```
392424

@@ -492,12 +524,25 @@ await client.listImportTasks({ collection_name });
492524
```typescript
493525
await client.flush({ collection_names: string[] });
494526
await client.flushSync({ collection_names: string[] }); // Wait for completion
527+
await client.flushAll(); // Flush all collections
528+
await client.flushAllSync(); // Flush all and wait for completion
495529
await client.compact({ collection_name });
496530
await client.getCompactionState({ compactionID });
497531
```
498532

499533
---
500534

535+
### System Operations
536+
537+
```typescript
538+
await client.getVersion(); // Milvus server version
539+
await client.checkHealth(); // Server health status
540+
await client.reconnectToPrimary(); // Force reconnect to primary node
541+
await client.runAnalyzer({ text, analyzer }); // Test text analyzer tokenization
542+
```
543+
544+
---
545+
501546
## Data Types
502547

503548
### Scalar Types
@@ -778,6 +823,17 @@ await client.search({
778823

779824
---
780825

826+
### Advanced Features
827+
828+
For detailed guides on advanced features, visit the documentation:
829+
830+
- **[Hybrid Search](docs/content/operations/hybrid-search.mdx)** — Multi-vector search with reranking
831+
- **[Full-Text Search](docs/content/advanced/full-text-search.mdx)** — BM25 keyword search with text analyzers
832+
- **[Iterators](docs/content/operations/iterators.mdx)** — Paginate through large result sets
833+
- **[Global Cluster](docs/content/advanced/global-cluster.mdx)** — Multi-region failover support
834+
835+
---
836+
781837
## Links
782838

783839
- [Full Documentation](https://milvus-io.github.io/milvus-sdk-node)

0 commit comments

Comments
 (0)