Azure OpenAI

使用API密钥​

1. 在Azure OpenAI上创建账户并获取您的API密钥。

2. 创建模型的新部署并获取部署名称。

3. 将以下内容添加到您的taskweaver_config.json文件中：

   {
     "llm.api_base":"YOUR_AOAI_ENDPOINT", // 格式为 https://.openai.azure.com"
     "llm.api_key":"YOUR_API_KEY",
     "llm.api_type":"azure",
     "llm.model":"gpt-4-1106-preview", // 在Azure OpenAI中称为deployment_name
     "llm.response_format": "json_object",
     "llm.azure.api_version": "2024-06-01"
   }
   
   信息

   对于1106版本或之后的模型，可以将llm.response_format设置为json_object。 但对于早期不支持JSON显式响应的模型，应将llm.response_format设置为null。

4. 启动TaskWeaver并与TaskWeaver进行对话。

   更多详情请参考快速入门。

使用Entra身份验证​

1. 在Azure OpenAI上创建账户，并为您的账户（或服务主体）分配适当的Azure RBAC角色。

2. 创建模型的新部署并获取部署名称。

3. 将以下内容添加到您的 taskweaver_config.json 文件中：

   {
     "llm.api_base":"YOUR_AOAI_ENDPOINT", // 格式为 https://.openai.azure.com"
     "llm.api_type":"azure_ad",
     "llm.model":"gpt-4-1106-preview", // 在Azure OpenAI中称为deployment_name
     "llm.response_format": "json_object",
     "llm.azure_ad.api_version": "2024-06-01",
     "llm.azure_ad.aad_auth_mode": "default_azure_credential"
   }
   

4. 安装额外依赖项：

   pip install azure-identity
   

5. 可选配置指定认证方法所需的其他环境变量或依赖项：

   在内部，身份验证由azure-identity包中的DefaultAzureCredential类处理。它会根据当前运行环境的可用性（例如环境变量、托管身份等）尝试使用一系列方法进行身份验证。更多详情可以参考官方文档。

   例如，您可以指定不同的环境变量来控制认证方法：

   1. 使用AzureCLI进行身份验证（推荐用于本地开发）：

      安装AzureCLI并确保az可在您的PATH中找到。然后运行以下命令登录：

      az login
      

   2. 使用托管身份验证（Azure环境推荐）：

      如果在Azure上运行TaskWeaver，可以使用托管身份进行身份验证。您可以查阅具体Azure服务的文档了解如何启用托管身份。

      使用用户分配的托管身份时，可以设置以下环境变量来指定托管身份的客户端ID：

      export AZURE_CLIENT_ID="YOUR_CLIENT_ID"
      

   3. 使用服务主体进行认证：

      您可以按照官方文档中的说明来设置服务主体认证所需的环境变量。

6. 启动TaskWeaver并与TaskWeaver进行对话。