Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR modernizes the C# SDK documentation for sdk_v2 by rewriting the README to reflect actual v2 APIs, enabling XML doc generation during build, and adding an auto-generated API reference set under docs/api/.
Changes:
- Rewrites
sdk_v2/cs/README.mdwith updated v2 usage examples and expanded sections (WinML, streaming, web service, configuration, tests). - Enables XML doc output (
<GenerateDocumentationFile>true</GenerateDocumentationFile>) and fixes an XML doc<param>mismatch inModel.SelectVariant. - Adds
GENERATE-DOCS.mdplus generated API reference markdown files indocs/api/.
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk_v2/cs/src/Model.cs | Fixes XML doc <param> name for SelectVariant. |
| sdk_v2/cs/src/Microsoft.AI.Foundry.Local.csproj | Enables XML documentation file generation at build time. |
| sdk_v2/cs/README.md | Full rewrite of usage docs and examples for the v2 C# SDK. |
| sdk_v2/cs/GENERATE-DOCS.md | Documents how to regenerate API reference markdown using xmldoc2md. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.runtime.md | Adds generated API doc for Runtime. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.prompttemplate.md | Adds generated API doc for PromptTemplate. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.parameter.md | Adds generated API doc for Parameter. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.openaichatclient.md | Adds generated API doc for OpenAIChatClient. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.openaiaudioclient.md | Adds generated API doc for OpenAIAudioClient. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.modelvariant.md | Adds generated API doc for ModelVariant. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.modelsettings.md | Adds generated API doc for ModelSettings. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.modelinfo.md | Adds generated API doc for ModelInfo. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.model.md | Adds generated API doc for Model. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.loglevel.md | Adds generated API doc for LogLevel. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.imodel.md | Adds generated API doc for IModel. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.icatalog.md | Adds generated API doc for ICatalog. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.foundrylocalmanager.md | Adds generated API doc for FoundryLocalManager. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.foundrylocalexception.md | Adds generated API doc for FoundryLocalException. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.devicetype.md | Adds generated API doc for DeviceType. |
| sdk_v2/cs/docs/api/microsoft.ai.foundry.local.configuration.md | Adds generated API doc for Configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sdk_v2/cs/docs/api/microsoft.ai.foundry.local.foundrylocalmanager.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 26 out of 27 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 26 out of 27 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 26 out of 27 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 26 out of 27 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This reverts commit 396bdf0.
C# SDK Docs Update Summary
What changed
README.md — Complete rewrite. The old README referenced non-existent v2 APIs (
StartModelAsync,GetModelInfoAsync) and wrong build paths. New version is feature-focused with correct v2 API usage throughout.Sections added: Features, Installation, WinML (top-level), Quick Start, Usage (Initialization, Catalog, Model Lifecycle, Chat Completions, Streaming, Chat Settings, Audio Transcription, Audio Settings, Web Service, Configuration table, Disposal), API Reference, Tests.
Microsoft.AI.Foundry.Local.csproj — Added
<GenerateDocumentationFile>true</GenerateDocumentationFile>to emit XML docs at build time. Fixed a mismatched<param>tag onModel.SelectVariant(modelId→variant) that became a build error with doc generation enabled.GENERATE-DOCS.md — New file documenting how to regenerate the API reference markdown using xmldoc2md.
docs/api/*.md — 16 auto-generated API reference files from XML doc comments
Files added
GENERATE-DOCS.mddocs/api/(16 files)Files modified
README.mdsrc/Microsoft.AI.Foundry.Local.csprojsrc/Model.cs(param tag fix)