Skip to content

Commit 0285799

Browse files
diberryCopilot
andauthored
fix: relax instruction rules for select-algorithm sample pattern (#81)
- Add select-algorithm as distinct sample category (compare_all vs per-algo) - Update repo structure to include select-algorithm directories - Relax query text rule (select-algo may use different query) - Update output file expectations per sample category Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent c58bac6 commit 0285799

2 files changed

Lines changed: 16 additions & 3 deletions

File tree

.github/copilot-instructions.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,29 @@ ai/
1313
├── vector-search-go/ # Go vector search samples
1414
├── vector-search-java/ # Java vector search samples
1515
├── vector-search-dotnet/ # .NET vector search samples
16+
├── select-algorithm-python/ # Python select algorithm quickstart
17+
├── select-algorithm-typescript/ # TypeScript select algorithm quickstart
18+
├── select-algorithm-go/ # Go select algorithm quickstart
19+
├── select-algorithm-java/ # Java select algorithm quickstart
20+
├── select-algorithm-dotnet/ # .NET select algorithm quickstart
1621
├── vector-search-agent-go/ # Go agent sample (separate from quickstart)
1722
└── vector-search-agent-typescript/ # TypeScript agent sample (separate from quickstart)
1823
```
1924

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

24-
Each quickstart sample directory contains:
30+
Vector search quickstart directories contain:
2531
- `src/` — Source files: one per algorithm (`ivf`, `hnsw`, `diskann`) + `utils` + `create_embeddings` + `show_indexes`
2632
- `output/` — Expected output files: `ivf.txt`, `hnsw.txt`, `diskann.txt`
33+
34+
Select algorithm quickstart directories contain:
35+
- `src/` — Source files: `compare_all` (or equivalent) + `utils`
36+
- `output/` — Expected output: `compare_all.txt` (all algorithms compared in one run)
37+
38+
All sample directories include:
2739
- `README.md` — Setup, usage, and troubleshooting documentation
2840
- `.env.example` (Go, Python, TypeScript) or `appsettings.json` (.NET) — Configuration template
2941

.github/instructions/execution-patterns.instructions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ All vector search samples follow this consistent lifecycle:
3939
- **Database name:** `Hotels` (hardcoded, matches `AZURE_DOCUMENTDB_DATABASENAME` default)
4040

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

4445
### Vector Search Pipeline Structure
4546
All languages use the same aggregation pipeline structure:

0 commit comments

Comments
 (0)