11# AWS S3 Vectors Rust CLI
2+ Unofficial CLI for AWS S3 Vectors with RAG capabilities.
23
34![ welcome.png] ( docs/welcome.png )
45
5- Unofficial CLI for AWS S3 Vectors with RAG capabilities.
6+ ![ ingest-docs.png] ( docs/ingest-docs.png )
7+
8+ ![ query-contexts.png] ( docs/query-contexts.png )
69
710## Installation
811
@@ -23,6 +26,9 @@ s3-vectors
2326s3-vectors bucket create my-vectors
2427s3-vectors index create my-vectors embeddings -d 384
2528
29+ # Query buckets
30+ s3-vectors bucket query prod --status active
31+
2632# Add vectors
2733s3-vectors vector put my-vectors embeddings key1 -d " 0.1,0.2,0.3..."
2834
@@ -34,10 +40,12 @@ s3-vectors vector query my-vectors embeddings -q "0.1,0.2,0.3..." -t 10
3440
3541### Bucket Operations
3642- ` bucket create/list/get/delete <name> `
43+ - ` bucket query [pattern] [--status active] [--created-after date] `
3744
3845### Index Operations
3946- ` index create <bucket> <name> -d <dimensions> [-m cosine|euclidean] `
40- - ` index list/get/delete <bucket> <name> `
47+ - ` index list <bucket> [--query "natural language search"] `
48+ - ` index get/delete <bucket> <name> `
4149
4250### Vector Operations
4351- ` vector put <bucket> <index> <key> -d <data> [-m metadata] `
@@ -46,6 +54,23 @@ s3-vectors vector query my-vectors embeddings -q "0.1,0.2,0.3..." -t 10
4654- ` vector query <bucket> <index> -q <vector> -t <top_k> `
4755- ` vector delete <bucket> <index> <keys> `
4856
57+ ### RAG Operations
58+ ```
59+ # Initialize RAG pipeline
60+ s3-vectors rag init --bucket rag-demo-sigrid --index documents-sigrid
61+
62+ # Ingest documents
63+ s3-vectors rag ingest --directory ./docs --bucket rag-demo-sigrid --index documents-sigrid
64+
65+ # Query with natural language
66+ s3-vectors rag query "what is AI?" --top-k 5 --bucket rag-demo-sigrid --index documents-sigrid
67+
68+ # Or use interactive mode
69+ s3-vectors rag interactive --bucket rag-demo-sigrid --index documents-sigrid
70+ > what is AI?
71+ > how does machine learning work?
72+ ```
73+
4974### Policy Management
5075- ` policy put/get/delete <bucket> [-f file | -p inline] `
5176
@@ -80,7 +105,7 @@ Run `s3-vectors` without arguments for REPL mode:
80105- ` AWS_PROFILE `
81106
82107## Demo
83- ### RAGDemo
108+ ### RAG Demo
84109```
85110cargo build --release --example rag_demo
86111cargo run --example rag_demo -- init
0 commit comments