Azure SDK for .NET人工智能服务：认知服务API调用详解
项目地址: https://gitcode.com/GitHub_Trending/az/azure-sdk-for-net 在当今数字化时代，人工智能技术正以前所未有的速度融入各行各业，为企业和开发者带来了无限可能。Azure SDK for .NET作为连接开发者与Azure丰富AI服务的桥梁，提供了便捷高效的API调用方式。本文将详细介绍如何利用Azure SDK for .NET调用认知服务API，帮助开发者快速上手并实现各种AI功能。
准备工作
在开始调用Azure认知服务API之前，需要完成一些必要的准备工作。首先，你需要拥有一个Azure账号，并创建相应的认知服务资源。然后，获取资源的 endpoint（端点）和 key（密钥），这些信息将用于API调用的身份验证。
环境变量设置
在调用API之前，需要设置两个环境变量：
- AZURE_AI_CHAT_ENDPOINT：你的端点URL，格式为
https://your-deployment-name.your-azure-region.inference.ai.azure.com，其中your-deployment-name是你的AI模型部署名称，your-azure-region是模型部署所在的Azure区域。 - AZURE_AI_CHAT_KEY：你的模型密钥，需要妥善保管。
核心API调用流程
Azure SDK for .NET提供了简洁易用的API，使得调用认知服务变得非常简单。下面以聊天补全（Chat Completions）API为例，介绍核心的调用流程。
创建客户端
首先，需要创建一个 ChatCompletionsClient 对象，该对象是与Azure认知服务进行交互的核心。创建客户端时需要传入 endpoint、credential（凭证）和客户端选项。
var endpoint = new Uri(System.Environment.GetEnvironmentVariable("AZURE_AI_CHAT_ENDPOINT"));
var credential = new AzureKeyCredential(System.Environment.GetEnvironmentVariable("AZURE_AI_CHAT_KEY"));
var client = new ChatCompletionsClient(endpoint, credential, new AzureAIInferenceClientOptions());
AI功能源码：sdk/ai/Azure.AI.Inference/src/
构建请求参数
接下来，需要构建聊天补全请求参数 ChatCompletionsOptions，其中最重要的是 Messages 属性，用于指定对话历史。对话历史由一系列消息组成，包括系统消息（System Message）、用户消息（User Message）等。
var requestOptions = new ChatCompletionsOptions()
{
Messages =
{
new ChatRequestSystemMessage("You are a helpful assistant."),
new ChatRequestUserMessage("How many feet are in a mile?"),
},
};
发送请求并获取响应
最后，调用 Complete 方法发送同步请求，或 CompleteAsync 方法发送异步请求，获取聊天补全响应。
同步调用
Response<ChatCompletions> response = client.Complete(requestOptions);
System.Console.WriteLine(response.Value.Content);
异步调用
Response<ChatCompletions> response = await client.CompleteAsync(requestOptions);
System.Console.WriteLine(response.Value.Content);
社区教程：sdk/ai/Azure.AI.Inference/samples/Sample1_ChatCompletions.md
常见功能示例
Azure认知服务提供了多种AI功能，如人脸识别、文本分析、语音识别等。下面介绍一些常见功能的API调用示例。
聊天补全
聊天补全功能可以根据用户的输入生成自然语言响应，广泛应用于智能客服、聊天机器人等场景。前面已经介绍了基本的聊天补全API调用，下面是一个更复杂的示例，展示如何处理多轮对话。
var requestOptions = new ChatCompletionsOptions()
{
Messages =
{
new ChatRequestSystemMessage("You are a helpful assistant that answers questions about history."),
new ChatRequestUserMessage("Who was the first head of state of the United States?"),
new ChatRequestAssistantMessage("The first head of state of the United States was George Washington."),
new ChatRequestUserMessage("When was he born?"),
},
};
var response = await client.CompleteAsync(requestOptions);
System.Console.WriteLine(response.Value.Content);
图像相关功能
Azure认知服务还提供了图像相关的功能，如图像嵌入（Image Embeddings）、图像分析等。虽然本文主要关注文本相关的API调用，但你可以通过查阅相关文档了解更多图像功能的使用方法。
图像功能源码：sdk/ai/Azure.AI.Inference/samples/images/
注意事项
在调用Azure认知服务API时，需要注意以下几点：
- 身份验证安全：密钥是访问Azure资源的重要凭证，需要妥善保管，避免泄露。建议使用环境变量或安全的配置管理方式存储密钥，不要硬编码在代码中。
- 请求限制：Azure认知服务对API调用有一定的请求限制，如每秒请求数、每分钟请求数等。如果超出限制，服务会返回错误响应，需要在代码中处理这些错误情况。
- 错误处理：在API调用过程中，可能会遇到各种错误，如网络错误、身份验证错误、参数错误等。需要使用 try-catch 语句捕获异常，并进行适当的错误处理。
错误处理示例代码：
try
{
var response = await client.CompleteAsync(requestOptions);
System.Console.WriteLine(response.Value.Content);
}
catch (RequestFailedException ex)
{
System.Console.WriteLine($"API call failed: {ex.Message}");
// 处理错误，如重试、记录日志等
}
总结与展望
本文详细介绍了如何使用Azure SDK for .NET调用认知服务API，包括准备工作、核心API调用流程、常见功能示例以及注意事项。通过Azure SDK for .NET，开发者可以轻松地将Azure强大的AI功能集成到自己的应用程序中，为用户提供更加智能、便捷的服务。
随着人工智能技术的不断发展，Azure认知服务也在不断推出新的功能和服务。未来，我们可以期待更多先进的AI能力通过SDK提供给开发者，帮助开发者构建更加创新的应用。
如果你对Azure SDK for .NET的使用有任何疑问，或者想要了解更多高级功能，可以查阅官方文档或参与社区讨论。
官方文档：SUPPORT.md
希望本文能够帮助你快速掌握Azure SDK for .NET认知服务API的调用方法，祝你的开发工作顺利！
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
