Skip to content

Commit e711ad7

Browse files
committed
add search/retreive example
1 parent 49eb078 commit e711ad7

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,20 @@ chunks = chunk_text("Your document text here...", config)
6060

6161
**Note**: Semantic chunking uses sentence-transformers for chunking decisions, but the resulting chunks are embedded using your collection's embedding model (e.g., nomic-embed-text) for search operations.
6262

63+
### Testing Semantic Chunking
64+
65+
You can test the semantic chunking functionality using the CLI:
66+
67+
```bash
68+
# Check collection information to see chunking strategy
69+
cli/maestro-k collection info --vdb "Qiskit_studio_algo" --name "Qiskit_studio_algo"
70+
71+
# Search with semantic chunking to see results
72+
./cli/maestro-k search "quantum circuit" --vdb qiskit_studio_algo --collection qiskit_studio_algo --doc-limit 1
73+
```
74+
75+
**Note**: The semantic chunking strategy uses sentence-transformers for chunking decisions, while the collection's own embedding model is used for search operations.
76+
6377
## Quick Start
6478

6579
### Installation

cli/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1013,3 +1013,20 @@ go test -v ./tests/...
10131013
## License
10141014

10151015
Apache 2.0 License - see the main project LICENSE file for details.
1016+
1017+
## Semantic Chunking Example
1018+
1019+
The CLI supports semantic chunking for intelligent document splitting:
1020+
1021+
```bash
1022+
# Create a collection with semantic chunking
1023+
cli/maestro-k collection create --vdb my-vdb --name my-collection
1024+
1025+
# Check collection information to see chunking strategy
1026+
cli/maestro-k collection info --vdb "Qiskit_studio_algo" --name "Qiskit_studio_algo"
1027+
1028+
# Search with semantic chunking to see results
1029+
./cli/maestro-k search "quantum circuit" --vdb qiskit_studio_algo --collection qiskit_studio_algo --doc-limit 1
1030+
```
1031+
1032+
**Note**: The semantic chunking strategy uses sentence-transformers for chunking decisions, while the collection's own embedding model is used for search operations.

0 commit comments

Comments
 (0)