AzureOpenAI-with-APIM 项目启动和配置教程

1. 项目目录结构及介绍

AzureOpenAI-with-APIM 项目的主要目录结构如下：

• api_definitions/：包含 OpenAPI 定义的 JSON 文件。
• apim_policies/：存放 APIM 策略文件。
• artifacts/：项目构建和部署所需的资源文件。
• example_code/：示例代码，用于展示如何通过 APIM 访问 Azure OpenAI。
• images/：存放项目相关的图片文件。
• kql_queries/：包含 KQL 查询脚本。
• modules/：可能包含项目的模块或库。
• .gitignore：指定 Git 忽略的文件和目录。
• CODE_OF_CONDUCT.md：项目行为准则。
• LICENSE：项目许可证信息。
• README.md：项目说明文件。
• SECURITY.md：项目安全相关说明。
• SUPPORT.md：项目支持信息。
• azure_roles.json：定义 Azure 角色的 JSON 文件。
• private-apim.bicep：私有 APIM 的 Bicep 脚本。
• private-apim.json：私有 APIM 的 JSON 配置。
• public-apim.bicep：公共 APIM 的 Bicep 脚本。
• public-apim.json：公共 APIM 的 JSON 配置。

2. 项目的启动文件介绍

项目的启动通常涉及到部署和配置 Azure 资源。在 README.md 文件中，提供了如何一键部署 APIM、Key Vault 和 Log Analytics 的说明。部署后，APIM 会自动配置以与 Azure OpenAI 端点协同工作。

• README.md：详细介绍了如何使用该项目，包括部署步骤和后续的使用方法。
• azure_roles.json：可能用于定义在 Azure 中需要的角色和权限。
• Bicep 脚本（private-apim.bicep 和 public-apim.bicep）：这些脚本用于在 Azure 中部署和管理 APIM 实例。

3. 项目的配置文件介绍

项目的配置文件用于定义和管理 APIM 的策略、权限和资源。

• apim_policies/：该目录下的文件定义了 APIM 策略，如优先级路由、速率限制、断路器等。
• private-apim.json 和 public-apim.json：这些 JSON 文件包含了 APIM 实例的配置信息。
• SECURITY.md：提供了关于项目安全配置的建议和信息。

请根据项目的具体需求和 Azure 环境对上述配置文件进行相应的调整和配置。确保所有的配置都符合组织的政策和安全要求。