chore: add .github/copilot-instructions.md#80
Merged
diberry merged 8 commits intoAzure-Samples:mainfrom May 8, 2026
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
added a commit
to diberry/documentdb-samples
that referenced
this pull request
May 8, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…, and code patterns - Add OpenAI SDK dependencies for Go, Java, and .NET - Add python-dotenv and godotenv dependencies - Fix DATA_FILE_WITH_VECTORS default from ./Hotels_Vector.json to ../data/Hotels_Vector.json - Add AZURE_OPENAI_EMBEDDING_API_VERSION and MONGO_CONNECTION_STRING to env var table - Add Authentication section documenting passwordless (OIDC) and connection string auth - Add Sample Execution Pattern section with consistent lifecycle, naming conventions, standard search query, and vector search pipeline structure - Add Repository Structure overview - Clarify Rule 1 exceptions (mongocluster.cosmos.azure.com, cosmosSearch, VS Code extension) - Fix Rule 3 to reference env var with shared data path default - Fix Rule 6 to list actual .NET config sections - Add rules for COS similarity, output files, and index type availability Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Document the agent sample patterns as a separate convention section covering: - Planner/Synthesizer two-agent architecture with 3 LLM deployments - Agent-specific env vars vs quickstart env var mapping - Entry point pattern (upload/agent/cleanup) - Language-specific SDK stacks (Go raw vs TS LangChain) - OIDC authentication scopes - IVF numLists discrepancy (10 vs 1) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Remove python-dotenv and godotenv from dependency lists - Add Rule 10: no dotenv libraries - Add 'Running Samples' section with per-language CLI examples - Include agent sample multi-LLM invocation example - Add Windows PowerShell note Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Main file trimmed from 377 to 156 lines (core rules, env vars, patterns) - .github/instructions/cli-examples.instructions.md: Bash/PowerShell invocation examples, scoped to ai/** paths - .github/instructions/agent-samples.instructions.md: Multi-LLM agent convention, scoped to ai/vector-search-agent-*/** paths Follows GitHub Copilot guidance to keep copilot-instructions.md concise and use path-specific .instructions.md files for detailed/scoped content. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- copilot-instructions.md now 107 lines (from 377 original) - New: .github/instructions/execution-patterns.instructions.md Scoped to ai/vector-search-*/** — covers auth modes, lifecycle, naming conventions, search query, pipeline structure Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Add Sample Categories section (quickstart vs agent distinction)
- Add IVF numLists footnote (quickstart=1, agents=10 intentional)
- Clarify .NET appsettings.json + env var override pattern
- Add Rule 11: collection naming convention (hotels_{algorithm})
- Add Rule 12: k=5 for vector search results
- Make DescriptionVector explicit in pipeline template
- Add note that CLI examples apply to all 3 algorithms
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds project-level Copilot instructions covering DocumentDB sample conventions: environment variables, vector index patterns, collection lifecycle, and language-specific notes.
Extracted from PR #74 to keep that PR focused on Article 2 select-algorithm samples.