快速入门：使用关键短语提取客户端库和 REST API

参考文档 | 其他示例 | 包 (NuGet) | 库源代码

借助本快速入门，使用 .NET 客户端库创建关键短语提取应用程序。 在以下示例中，你将创建可识别文本中的关键词和短语的 C# 应用程序。

先决条件

• Azure 订阅 - 创建试用订阅
• Visual Studio IDE
• 拥有 Azure 订阅后，请在 Azure 门户中创建语言资源，以获取密钥和终结点。 部署后，选择”转到资源”。
  • 需要从创建的资源获取密钥和终结点，以便将应用程序连接到 API。 你稍后会在快速入门中将密钥和终结点粘贴到下方的代码中。
  • 可以使用免费定价层 (Free F0) 试用该服务，然后再升级到付费层进行生产。
• 若要使用“分析”功能，需要标准 (S) 定价层的“语言”资源。

设置

创建新的 .NET Core 应用程序

使用 Visual Studio IDE 创建新的 .NET Core 控制台应用。 这会创建包含单个 C# 源文件的“Hello World”项目：program.cs。

右键单击解决方案资源管理器中的解决方案，然后选择“管理 NuGet 包”，以便安装客户端库。 在打开的包管理器中选择“浏览”，搜索 Azure.AI.TextAnalytics。 选择版本 5.2.0，然后选择“安装”。 也可使用包管理器控制台。

代码示例

将以下代码复制到 program.cs 文件。 请记得将 key 变量替换为资源的密钥，并将 endpoint 变量替换为资源的终结点。 然后运行代码。

using Azure;
using System;
using Azure.AI.TextAnalytics;

namespace KeyPhraseExtractionExample
{
    class Program
    {
        private static readonly AzureKeyCredential credentials = new AzureKeyCredential("replace-with-your-key-here");
        private static readonly Uri endpoint = new Uri("replace-with-your-endpoint-here");

        // Example method for extracting key phrases from text
        static void KeyPhraseExtractionExample(TextAnalyticsClient client)
        {
            var response = client.ExtractKeyPhrases(@"Dr. Smith has a very modern medical office, and she has great staff.");

            // Printing key phrases
            Console.WriteLine("Key phrases:");

            foreach (string keyphrase in response.Value)
            {
                Console.WriteLine($"\t{keyphrase}");
            }
        }

        static void Main(string[] args)
        {
            var client = new TextAnalyticsClient(endpoint, credentials);
            KeyPhraseExtractionExample(client);

            Console.Write("Press any key to exit.");
            Console.ReadKey();
        }

    }
}

输出

Key phrases:
    modern medical office
    Dr. Smith
    great staff

参考文档 | 其他示例 | 包 (Maven) | 库源代码

借助本快速入门，使用 Java 客户端库创建关键短语提取应用程序。 在以下示例中，你将创建可识别文本中的关键词和短语的 Java 应用程序。

先决条件

• Azure 订阅 - 创建试用订阅
• Java 开发工具包 (JDK) 版本 8 或更高版本
• 拥有 Azure 订阅后，请在 Azure 门户中创建语言资源，以获取密钥和终结点。 部署后，选择”转到资源”。
  • 需要从创建的资源获取密钥和终结点，以便将应用程序连接到 API。 你稍后会在快速入门中将密钥和终结点粘贴到下方的代码中。
  • 可以使用免费定价层 (Free F0) 试用该服务，然后再升级到付费层进行生产。
• 若要使用“分析”功能，需要标准 (S) 定价层的“语言”资源。

设置

添加客户端库

在首选 IDE 或开发环境中创建 Maven 项目。 然后在项目的 pom.xml 文件中，添加以下依赖项。 可联机找到用于其他生成工具的实现语法。

<dependencies>
     <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-ai-textanalytics</artifactId>
        <version>5.2.0</version>
    </dependency>
</dependencies>

代码示例

创建名为 Example.java 的 Java 文件。 打开该文件，并复制以下代码。 请记得将 key 变量替换为资源的密钥，并将 endpoint 变量替换为资源的终结点。 然后运行代码。

import com.azure.core.credential.AzureKeyCredential;
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.TextAnalyticsClient;


public class Example {

    private static String KEY = "replace-with-your-key-here";
    private static String ENDPOINT = "replace-with-your-endpoint-here";

    public static void main(String[] args) {
        TextAnalyticsClient client = authenticateClient(KEY, ENDPOINT);
        extractKeyPhrasesExample(client);
    }
    // Method to authenticate the client object with your key and endpoint
    static TextAnalyticsClient authenticateClient(String key, String endpoint) {
        return new TextAnalyticsClientBuilder()
                .credential(new AzureKeyCredential(key))
                .endpoint(endpoint)
                .buildClient();
    }
    // Example method for extracting key phrases from text
    static void extractKeyPhrasesExample(TextAnalyticsClient client)
    {
        // The text to be analyzed
        String text = "Dr. Smith has a very modern medical office, and she has great staff.";

        System.out.printf("Recognized phrases: %n");
        for (String keyPhrase : client.extractKeyPhrases(text)) {
            System.out.printf("%s%n", keyPhrase);
        }
    }
}

输出

Recognized phrases: 

modern medical office
Dr. Smith
great staff

参考文档 | 其他示例 | 包 (npm) | 库源代码

借助本快速入门，使用 Node.js 客户端库创建关键短语提取应用程序。 在以下示例中，你将创建可识别文本中的关键词和短语的 JavaScript 应用程序。

先决条件

• Azure 订阅 - 创建试用订阅
• Node.js v14 LTS 或更高版本
• 拥有 Azure 订阅后，请在 Azure 门户中创建语言资源，以获取密钥和终结点。 部署后，选择”转到资源”。
  • 需要从创建的资源获取密钥和终结点，以便将应用程序连接到 API。 你稍后会在快速入门中将密钥和终结点粘贴到下方的代码中。
  • 可以使用免费定价层 (Free F0) 试用该服务，然后再升级到付费层进行生产。
• 若要使用“分析”功能，需要标准 (S) 定价层的“语言”资源。

设置

创建新的 Node.js 应用程序

在控制台窗口（例如 cmd、PowerShell 或 Bash）中，为应用创建一个新目录并导航到该目录。

mkdir myapp 

cd myapp

运行 npm init 命令以使用 package.json 文件创建一个 node 应用程序。

npm init

安装客户端库

安装 npm 包：

npm install @azure/ai-language-text

代码示例

打开该文件，并复制以下代码。 请记得将 key 变量替换为资源的密钥，并将 endpoint 变量替换为资源的终结点。 然后运行代码。

"use strict";

const { TextAnalysisClient, AzureKeyCredential } = require("@azure/ai-language-text");
const key = '<paste-your-key-here>';
const endpoint = '<paste-your-endpoint-here>';

//example sentence for performing key phrase extraction
const documents = ["Dr. Smith has a very modern medical office, and she has great staff."];

//example of how to use the client to perform entity linking on a document
async function main() {
    console.log("== key phrase extraction sample ==");
  
    const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
  
    const results = await client.analyze("KeyPhraseExtraction", documents);
  
    for (const result of results) {
      console.log(`- Document ${result.id}`);
      if (!result.error) {
        console.log("\tKey phrases:");
        for (const phrase of result.keyPhrases) {
          console.log(`\t- ${phrase}`);
        }
      } else {
        console.error("  Error:", result.error);
      }
    }
  }
  
  main().catch((err) => {
    console.error("The sample encountered an error:", err);
  });
  

输出

== key phrase extraction sample ==
- Document 0
    Key phrases:
    - modern medical office
    - Dr. Smith
    - great staff

参考文档 | 其他示例 | 包 (PyPi) | 库源代码

借助本快速入门，使用 Python 客户端库创建关键短语提取应用程序。 在以下示例中，你将创建可识别文本中的关键词和短语的 Python 应用程序。

先决条件

• Azure 订阅 - 创建试用订阅
• Python 3.8 或更高版本
• 拥有 Azure 订阅后，请在 Azure 门户中创建语言资源，以获取密钥和终结点。 部署后，选择”转到资源”。
  • 需要从创建的资源获取密钥和终结点，以便将应用程序连接到 API。 你稍后会在快速入门中将密钥和终结点粘贴到下方的代码中。
  • 可以使用免费定价层 (Free F0) 试用该服务，然后再升级到付费层进行生产。
• 若要使用“分析”功能，需要标准 (S) 定价层的“语言”资源。

设置

安装客户端库

在安装 Python 后，可以通过以下命令安装客户端库：

pip install azure-ai-textanalytics==5.2.0

代码示例

创建新的 Python 文件，并复制以下代码。 请记得将 key 变量替换为资源的密钥，并将 endpoint 变量替换为资源的终结点。 然后运行代码。

key = "paste-your-key-here"
endpoint = "paste-your-endpoint-here"

from azure.ai.textanalytics import TextAnalyticsClient
from azure.core.credentials import AzureKeyCredential

# Authenticate the client using your key and endpoint 
def authenticate_client():
    ta_credential = AzureKeyCredential(key)
    text_analytics_client = TextAnalyticsClient(
            endpoint=endpoint, 
            credential=ta_credential)
    return text_analytics_client

client = authenticate_client()

def key_phrase_extraction_example(client):

    try:
        documents = ["Dr. Smith has a very modern medical office, and she has great staff."]

        response = client.extract_key_phrases(documents = documents)[0]

        if not response.is_error:
            print("\tKey Phrases:")
            for phrase in response.key_phrases:
                print("\t\t", phrase)
        else:
            print(response.id, response.error)

    except Exception as err:
        print("Encountered exception. {}".format(err))
        
key_phrase_extraction_example(client)

输出

Key Phrases:
    modern medical office
    Dr. Smith
    great staff

参考文档

借助本快速入门，使用 REST API 发送关键短语提取请求。 在以下示例中，你将使用 cURL 来识别文本中的关键词和短语。

先决条件

• Azure 订阅 - 创建试用订阅
• 最新版本的 cURL。
• 拥有 Azure 订阅后，请在 Azure 门户中创建语言资源，以获取密钥和终结点。 部署后，选择”转到资源”。
  • 需要从创建的资源获取密钥和终结点，以便将应用程序连接到 API。 你稍后会在快速入门中将密钥和终结点粘贴到下方的代码中。
  • 可以使用免费定价层 (Free F0) 试用该服务，然后再升级到付费层进行生产。

以下 cURL 命令从 BASH shell 中执行。 请使用自己的资源名称、资源密钥和 JSON 值编辑这些命令。

关键短语提取

1. 将命令复制到文本编辑器中。
2. 必要时在命令中进行如下更改：
   1. 将值 <your-language-resource-key> 替换为你的值。
   2. 将请求 URL 的第一部分 (<your-language-resource-endpoint>) 替换为你的终结点 URL。
3. 打开命令提示符窗口。
4. 将文本编辑器中的命令粘贴到命令提示符窗口，然后运行命令。

curl -i -X POST https://<your-language-resource-endpoint>/language/:analyze-text?api-version=2022-05-01 \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: <your-language-resource-key>" \
-d \
'
{
    "kind": "KeyPhraseExtraction",
    "parameters": {
        "modelVersion": "latest"
    },
    "analysisInput":{
        "documents":[
            {
                "id":"1",
                "language":"en",
                "text": "Dr. Smith has a very modern medical office, and she has great staff."
            }
        ]
    }
}
'

JSON 响应

{
	"kind": "KeyPhraseExtractionResults",
	"results": {
		"documents": [{
			"id": "1",
			"keyPhrases": ["modern medical office", "Dr. Smith", "great staff"],
			"warnings": []
		}],
		"errors": [],
		"modelVersion": "2021-06-01"
	}
}