Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,29 @@ ai/
├── vector-search-go/ # Go vector search samples
├── vector-search-java/ # Java vector search samples
├── vector-search-dotnet/ # .NET vector search samples
├── select-algorithm-python/ # Python select algorithm quickstart
├── select-algorithm-typescript/ # TypeScript select algorithm quickstart
├── select-algorithm-go/ # Go select algorithm quickstart
├── select-algorithm-java/ # Java select algorithm quickstart
├── select-algorithm-dotnet/ # .NET select algorithm quickstart
├── vector-search-agent-go/ # Go agent sample (separate from quickstart)
└── vector-search-agent-typescript/ # TypeScript agent sample (separate from quickstart)
```

### Sample Categories
- **Quickstart samples** (`vector-search-{language}/`): Single algorithm per file, one entry point, uses `MONGO_CLUSTER_NAME` + quickstart env vars
- **Vector search quickstarts** (`vector-search-{language}/`): Single algorithm per file, one entry point, uses `MONGO_CLUSTER_NAME` + quickstart env vars
- **Select algorithm quickstarts** (`select-algorithm-{language}/`): Compares all 3 algorithms in one run, single entry point, uses `MONGO_CLUSTER_NAME` + quickstart env vars
- **Agent samples** (`vector-search-agent-{language}/`): Multi-LLM orchestration, three entry points (upload/agent/cleanup), uses `AZURE_DOCUMENTDB_*` env vars

Each quickstart sample directory contains:
Vector search quickstart directories contain:
- `src/` — Source files: one per algorithm (`ivf`, `hnsw`, `diskann`) + `utils` + `create_embeddings` + `show_indexes`
- `output/` — Expected output files: `ivf.txt`, `hnsw.txt`, `diskann.txt`

Select algorithm quickstart directories contain:
- `src/` — Source files: `compare_all` (or equivalent) + `utils`
- `output/` — Expected output: `compare_all.txt` (all algorithms compared in one run)

All sample directories include:
- `README.md` — Setup, usage, and troubleshooting documentation
- `.env.example` (Go, Python, TypeScript) or `appsettings.json` (.NET) — Configuration template

Expand Down
3 changes: 2 additions & 1 deletion .github/instructions/execution-patterns.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ All vector search samples follow this consistent lifecycle:
- **Database name:** `Hotels` (hardcoded, matches `AZURE_DOCUMENTDB_DATABASENAME` default)

### Standard Search Query
All samples use the same query text: `"quintessential lodging near running trails, eateries, retail"`
- **Vector search quickstarts:** `"quintessential lodging near running trails, eateries, retail"`
- **Select algorithm quickstarts:** May use a different query (e.g., `"luxury hotel near the beach"`) to highlight algorithm comparison differences

### Vector Search Pipeline Structure
All languages use the same aggregation pipeline structure:
Expand Down