使用AzureOpenAI的基础聊天-端到端示例
文档摘要
使用 Azure OpenAI 的基础聊天 - 端到端示例 此示例展示了如何创建一个简单的 Spring Boot 应用程序，连接到 Azure OpenAI 并测试您的设置。 目录 前置条件 快速开始 配置选项 选项 1：环境变量 (.env 文件) - 推荐 选项 2：GitHub Codespace Secrets 运行应用程序 使用 Maven 使用 VS Code 预期输出 配置参考 环境变量 Spring 配置 故障排除 常见问题 调试模式 下一步 资源 前置条件 在运行此示例之前，请确保您已完成以下操作： 完成 Azure OpenAI 设置指南 部署 Azure OpenAI 资源（通过 Azure AI Foundry 门户） 部署 gpt-4o-mini
使用 Azure OpenAI 的基础聊天 - 端到端示例
此示例展示了如何创建一个简单的 Spring Boot 应用程序，连接到 Azure OpenAI 并测试您的设置。
目录
前置条件
在运行此示例之前，请确保您已完成以下操作：
- 完成 Azure OpenAI 设置指南
- 部署 Azure OpenAI 资源（通过 Azure AI Foundry 门户）
- 部署 gpt-4o-mini 模型（或其他替代模型）
- 获取 Azure 的 API 密钥和端点 URL
快速开始
# 1. Navigate to project cd 02-SetupDevEnvironment/examples/basic-chat-azure # 2. Configure credentials cp .env.example .env # Edit .env with your Azure OpenAI credentials # 3. Run the application mvn spring-boot:run
配置选项
选项 1：环境变量 (.env 文件) - 推荐
步骤 1：创建您的配置文件
cp .env.example .env
步骤 2：添加您的 Azure OpenAI 凭据
# Your Azure OpenAI API key (from Azure AI Foundry portal) AZURE_AI_KEY=your-actual-api-key-here # Your Azure OpenAI endpoint URL (e.g., https://your-hub-name.openai.azure.com/) AZURE_AI_ENDPOINT=https://your-hub-name.openai.azure.com/
安全提示：
- 切勿将
.env文件提交到版本控制.env文件已被添加到.gitignore- 确保您的 API 密钥安全并定期轮换
选项 2：GitHub Codespace Secrets
对于 GitHub Codespaces，请在您的仓库中设置以下 Secrets：
AZURE_AI_KEY- 您的 Azure OpenAI API 密钥AZURE_AI_ENDPOINT- 您的 Azure OpenAI 端点 URL
应用程序会自动检测并使用这些 Secrets。
替代方案：直接使用环境变量
点击查看平台特定命令
Linux/macOS (bash/zsh):
export AZURE_AI_KEY=your-actual-api-key-here export AZURE_AI_ENDPOINT=https://your-hub-name.openai.azure.com/
Windows (命令提示符):
set AZURE_AI_KEY=your-actual-api-key-here set AZURE_AI_ENDPOINT=https://your-hub-name.openai.azure.com/
Windows (PowerShell):
$env:AZURE_AI_KEY="your-actual-api-key-here" $env:AZURE_AI_ENDPOINT="https://your-hub-name.openai.azure.com/"
运行应用程序
使用 Maven
mvn spring-boot:run
使用 VS Code
- 在 VS Code 中打开项目
- 按
F5或使用“运行和调试”面板 - 选择 "Spring Boot-BasicChatApplication" 配置
注意：VS Code 配置会自动加载您的 .env 文件
预期输出
Starting Basic Chat with Azure OpenAI... Environment variables loaded successfully Connecting to Azure OpenAI... Sending prompt: What is AI in a short sentence? Max 100 words. AI Response: ================ AI, or Artificial Intelligence, is the simulation of human intelligence in machines programmed to think and learn like humans. ================ Success! Azure OpenAI connection is working correctly.
配置参考
环境变量
| 变量 | 描述 | 必需 | 示例 |
|---|---|---|---|
AZURE_AI_KEY |
Azure OpenAI API 密钥 | 是 | abc123... |
AZURE_AI_ENDPOINT |
Azure OpenAI 端点 URL | 是 | https://my-hub.openai.azure.com/ |
AZURE_AI_MODEL_DEPLOYMENT |
模型部署名称 | 否 | gpt-4o-mini（默认） |
Spring 配置
application.yml 文件配置：
- API 密钥：
${AZURE_AI_KEY}- 来自环境变量 - 端点：
${AZURE_AI_ENDPOINT}- 来自环境变量 - 模型：
${AZURE_AI_MODEL_DEPLOYMENT:gpt-4o-mini}- 来自环境变量，带默认值 - 温度：
0.7- 控制创意性（0.0 = 确定性，1.0 = 创意性） - 最大令牌数：
500- 响应的最大长度
故障排除
常见问题
错误："API 密钥无效"
- 检查您的
AZURE_AI_KEY是否正确设置在.env文件中 - 确保 API 密钥完全复制自 Azure AI Foundry 门户
- 确保密钥周围没有额外的空格或引号
错误："端点无效"
- 确保您的
AZURE_AI_ENDPOINT包含完整的 URL（例如https://your-hub-name.openai.azure.com/） - 检查是否有一致的尾部斜杠
- 验证端点是否与您的 Azure 部署区域匹配
错误："未找到部署"
- 验证您的模型部署名称是否与 Azure 中部署的名称完全匹配
- 检查模型是否成功部署并处于活动状态
- 尝试使用默认部署名称：
gpt-4o-mini
VS Code：环境变量未加载
- 确保您的
.env文件位于项目根目录（与pom.xml同级） - 尝试在 VS Code 的集成终端中运行
mvn spring-boot:run - 检查 VS Code 的 Java 扩展是否正确安装
- 验证启动配置是否包含
"envFile": "${workspaceFolder}/.env"
调试模式
要启用详细日志记录，请取消注释 application.yml 中的以下行：
logging: level: org.springframework.ai: DEBUG com.azure: DEBUG
下一步
设置完成！ 继续您的学习之旅：
资源
免责声明：
本文档使用AI翻译服务Co-op Translator进行翻译。尽管我们努力确保翻译的准确性，但请注意，自动翻译可能包含错误或不准确之处。原始语言的文档应被视为权威来源。对于重要信息，建议使用专业人工翻译。我们对因使用此翻译而产生的任何误解或误读不承担责任。