aiagent-webapi 命令的详细使用说明

💡 安装项目模板

.NET CLI 安装 MAF 模板项目 Microsoft.Agents.AI.ProjectTemplates

bash 复制代码

dotnet new install Microsoft.Agents.AI.ProjectTemplates@1.0.0-preview.1.26160.2

使用 -h 查看命令帮助

bash 复制代码

PS C:\Users\Jeffrey> dotnet new aiagent-webapi -h
AI Agent Web API (C#)
作者: Microsoft
描述: A project template for creating an AI Agent Web API application.

用法:
  dotnet new aiagent-webapi [options] [模板选项]

选项:
  -n, --name <name>       正在创建的输出名称。如未指定名称，则使用输出目录的名称。
  -o, --output <output>   要放置生成的输出的位置。
  --dry-run               如果运行给定命令行将导致模板创建，则显示将发生情况的摘要。 [default: False]
  --force                 强制生成内容 (即使它会更改现有文件)。 [default: False]
  --no-update-check       在实例化模板时，禁用对模板包更新的检查。 [default: False]
  --project <project>     应用于上下文评估的项目。
  -lang, --language <C#>  指定要实例化的模板语言。
  --type <project>        指定要实例化的模板类型。

模板选项:
  -f, --framework <net10.0|net8.0|net9.0>  The target framework for the project.
                                           类型: choice
                                             net10.0  .NET 10
                                             net9.0   .NET 9
                                             net8.0   .NET 8
                                           默认: net10.0
  --provider <选项>                          类型: choice
                                             azureopenai   Uses Azure OpenAI service
                                             githubmodels  Uses GitHub Models
                                             ollama        Uses Ollama with the llama3.2 model
                                             openai        Uses the OpenAI Platform
                                           默认: githubmodels
  --managed-identity                       Use managed identity to access Azure services
                                           启用条件: (AiServiceProvider == "azureopenai")
                                           类型: bool
                                           默认: true
  --chat-model <chat-model>                Model/deployment for chat completions. Example: gpt-4o-mini
                                           类型: string

以下是 dotnet new aiagent-webapi 命令的详细使用说明。

📦 模板基本信息

模板名称 ：aiagent-webapi
语言：C#
作者：Microsoft
描述：用于创建 AI Agent Web API 应用程序的项目模板。

🚀 基本用法

bash 复制代码

dotnet new aiagent-webapi [options] [模板选项]

🔧 通用选项（Options）

选项	简写	描述
`--name <name>`	`-n`	指定生成项目的名称。若未指定，则使用输出目录名。
`--output <output>`	`-o`	指定生成文件的输出目录。
`--dry-run`	-	预演命令效果，不实际生成文件（仅显示将要创建的内容）。默认：`False`
`--force`	-	强制覆盖已有文件。默认：`False`
`--no-update-check`	-	禁用模板包更新检查。默认：`False`
`--project <project>`	-	指定用于上下文评估的已有项目文件（`.csproj`）。
`--language <C#>`	`-lang`	指定模板语言（当前仅支持 C#）。
`--type <project>`	-	指定模板类型（通常为 `project`）。

⚙️ 模板专属选项（Template Options）

1. 目标框架（Target Framework）

选项	简写	可选值	默认值	说明
`--framework`	`-f`	`net8.0` `net9.0` `net10.0`	`net10.0`	指定项目的目标 .NET 版本。

✅ 推荐根据你的运行环境选择合适的版本。

2. AI 服务提供商（AI Provider）

选项	类型	可选值	默认值	说明
`--provider`	choice	`azureopenai` `githubmodels` `ollama` `openai`	`githubmodels`	指定后端 AI 服务。

各选项说明：

azureopenai：使用 Azure OpenAI 服务
githubmodels：使用 GitHub Models （如 GitHub Copilot API）
ollama：本地运行 Ollama ，默认模型为 llama3.2
openai：使用 OpenAI 官方平台（需 API Key）

3. Azure 托管身份（仅限 Azure OpenAI）

选项	类型	启用条件	默认值	说明
`--managed-identity`	bool	`--provider azureopenai`	`true`	使用 Azure 托管身份访问 Azure 服务（无需显式密钥）。

⚠️ 此选项仅在 --provider azureopenai 时有效。

4. 聊天模型（Chat Model）

选项	类型	示例	说明
`--chat-model <chat-model>`	string	`gpt-4o-mini`	指定用于聊天补全的模型或部署名称。

若使用 Azure OpenAI ，此处应填写 部署名称（deployment name）
若使用 OpenAI / GitHub / Ollama ，填写模型标识符（如 gpt-4o, llama3.2 等）

💡 示例命令

示例 1：使用默认设置（GitHub Models + .NET 10）

bash 复制代码

dotnet new aiagent-webapi -n MyAgentApi -o ./MyAgentApi

示例 2：使用 OpenAI 和 GPT-4o Mini

bash 复制代码

dotnet new aiagent-webapi -n OpenAIAgent --provider openai --chat-model gpt-4o-mini --framework net8.0

示例 3：使用 Azure OpenAI（托管身份）

bash 复制代码

dotnet new aiagent-webapi -n AzureAgent --provider azureopenai --chat-model my-gpt4-deployment --managed-identity true

示例 4：使用本地 Ollama（llama3.2）

bash 复制代码

dotnet new aiagent-webapi -n LocalAgent --provider ollama --framework net9.0

ℹ️ 注意事项

确保已安装对应 .NET SDK（如 .NET 8/9/10）。
使用 openai 或 azureopenai 时，需在应用配置中提供 API 密钥或确保托管身份已配置。
--dry-run 可用于验证命令是否符合预期，避免误操作。

如需进一步定制，可结合 appsettings.json 或代码逻辑调整 AI 行为。