DevExpress Office File API是一個專為C#, VB.NET 和 ASP.NET等開發人員提供的非可視化.NET庫。有了這個庫，不用安裝Microsoft Office，就可以完全自動處理Excel、Word等文檔。開發人員使用一個非常易于操作的API就可以生成XLS, XLSx, DOC, DOCx, RTF, CSV 和 Snap Report等企業級文件。

在我們上一篇與AI相關的文章中（），描述了如何使用DevExpress Office File API庫和Azure AI OpenAI服務的可訪問性)為圖像和圖表生成AltText(有意義的描述)。在這篇文章中，我們將解釋如何為Word和Excel文件生成超鏈接描述。

當您生成可訪問的Word或Excel文檔時，創建帶有有意義的屏幕提示的超鏈接是必不可少的，有意義的屏幕提示可以幫助有視覺障礙的人或使用屏幕閱讀器的人理解超鏈接的目的，增加清晰度，并增強文檔導航。此外，當您將文檔導出為可訪問的PDF格式(與可訪問性標準(WCAG)保持一致)時，超鏈接屏幕提示非常重要。在DevExpress Word Processing Document API 和 Spreadsheet Document API庫的幫助下，您可以定位不提供可訪問描述的文檔超鏈接，并使用OpenAI模型生成這些描述。

獲取DevExpress Office File API正式版下載

DevExpress技術交流群10：532598169      歡迎一起進群討論

我們在GitHub上的示例項目中為該功能添加了兩個新的端點：，接下來將在下面詳細介紹實現步驟……

實現OpenAI模型API

注意：在您將此解決方案納入應用程序之前，請務必閱讀并理解OpenAI的許可協議和使用條款。

這一步類似于我們在之前的AI金喜正規買球相關的文章中演示過得步驟，在您的項目中安裝Azure.AI.OpenAI NuGet包，并使用OpenAI api發送請求。

這個代碼片段發送一個請求來描述一個超鏈接URI，并獲得一個帶有響應的字符串。

public class OpenAIClientHyperlinkHelper
{
OpenAIClient client;
internal OpenAIClientHyperlinkHelper(string openAIApiKey)
{
client = new OpenAIClient(openAIApiKey, new OpenAIClientOptions());
}
internal async Task<string> DescribeHyperlinkAsync(string link)
{
ChatCompletionsOptions chatCompletionsOptions = new()
{
DeploymentName = "gpt-4-vision-preview",
Messages =
{
new ChatRequestSystemMessage("You are a helpful assistant that describes hyperlinks."),
new ChatRequestUserMessage(
new ChatMessageTextContentItem("Give a description for this hyperlink URI in 10-20 words"),
new ChatMessageTextContentItem(link))
},
MaxTokens = 300
};

Response<ChatCompletions> chatResponse = await client.GetChatCompletionsAsync(chatCompletionsOptions);
ChatChoice choice = chatResponse.Value.Choices[0];
return choice.Message.Content;
}
}

Word Processing Document API端點

要在DevExpress支持的Word Processing Document API應用程序中使用上述API，請訪問集合來檢索文檔超鏈接。檢查文檔超鏈接是否包含提示( 屬性值不應為空或等于值），否則調用OpenAIClientHyperlinkHelper.DescribeHyperlinkAsync方法生成超鏈接描述信息。

public async Task<IActionResult> GenerateHyperlinkDescriptionForWord(IFormFile documentWithHyperlinks, [FromQuery] RichEditFormat outputFormat)
{
try
{
var hyperlinkHelper = new OpenAIClientHyperlinkHelper(openAIApiKey);
using (var wordProcessor = new RichEditDocumentServer())
{
await RichEditHelper.LoadFile(wordProcessor, documentWithHyperlinks);

wordProcessor.IterateSubDocuments(async (document) =>
{
foreach (var hyperlink in document.Hyperlinks)
{
if (string.IsNullOrEmpty(hyperlink.ToolTip) || hyperlink.ToolTip == hyperlink.NavigateUri)
{
hyperlink.ToolTip = hyperlinkHelper.DescribeHyperlinkAsync(hyperlink.NavigateUri).Result;
}
}
});
Stream result = RichEditHelper.SaveDocument(wordProcessor, outputFormat);
string contentType = RichEditHelper.GetContentType(outputFormat);
string outputStringFormat = outputFormat.ToString().ToLower();
return File(result, contentType, $"result.{outputStringFormat}");
}
}
catch (Exception e)
{
return StatusCode(500, e.Message + Environment.NewLine + e.StackTrace);
}
}

下圖顯示了使用此代碼生成的超鏈接描述。

Spreadsheet Document API端點

對于DevExpress支持的Spreadsheet Document API應用程序，迭代文檔工作表并使用集合訪問工作表超鏈接，完成后，必須確定 屬性是否滿足條件，并調用OpenAIClientHyperlinkHelper.  DescribeHyperlinkAsync方法，在需要時生成超鏈接描述。

public async Task<IActionResult> GenerateHyperlinkDescriptionForSpreadsheet(IFormFile documentWithHyperlinks, [FromQuery] SpreadsheetFormat outputFormat)
{
try
{
var hyperlinkHelper = new OpenAIClientHyperlinkHelper(openAIApiKey);
using (var workbook = new Workbook())
{
await SpreadsheetHelper.LoadWorkbook(workbook, documentWithHyperlinks);

foreach (var worksheet in workbook.Worksheets)
{
foreach (var hyperlink in worksheet.Hyperlinks)
{
if(hyperlink.IsExternal && (string.IsNullOrEmpty(hyperlink.TooltipText) || hyperlink.TooltipText == hyperlink.Uri))
hyperlink.TooltipText = hyperlinkHelper.DescribeHyperlinkAsync(hyperlink.Uri).Result;
}
}

Stream result = SpreadsheetHelper.SaveDocument(workbook, outputFormat);
string contentType = SpreadsheetHelper.GetContentType(outputFormat);
string outputStringFormat = outputFormat.ToString().ToLower();
return File(result, contentType, $"result.{outputStringFormat}");
}
}
catch (Exception e)
{
return StatusCode(500, e.Message + Environment.NewLine + e.StackTrace);
}
}

更多DevExpress線上公開課、中文教程資訊請上中文網獲取