Краткое руководство: использование клиентской библиотеки и REST API извлечения ключевых фраз

  • Статья

Справочная документация | Дополнительные примеры | Пакеты (NuGet) | Исходный код библиотеки

В этом кратком руководстве описано, как создать приложение для извлечения фраз с использованием клиентской библиотеки для .NET. В следующем примере показано, как создать приложение C#, которое может идентифицировать ключевые слова и фразы в тексте.

Совет

С помощью Language Studio можно опробовать функции языковой службы без написания кода.

Необходимые компоненты

  • Подписка Azure — создайте бесплатную учетную запись.
  • Интегрированная среда разработки Visual Studio.
  • После получения подписки Azure создайте ресурс языка в портал Azure, чтобы получить ключ и конечную точку. После развертывания ресурса выберите элемент Перейти к ресурсу.
    • Чтобы подключить приложение к API, потребуется ключ и конечная точка из созданного ресурса. Ключ и конечная точка будут вставлены в приведенный ниже код в кратком руководстве.
    • Используйте бесплатную ценовую категорию (Free F0), чтобы опробовать службу, а затем выполните обновление до платного уровня для рабочей среды.
  • Чтобы использовать функцию анализа, вам потребуется языковой ресурс ценовой категории "Стандартный" (S).

Установка

Создание приложения .NET Core

С помощью интегрированной среды разработки Visual Studio создайте консольное приложение .NET Core. Будет создан проект Hello World на языке C# с одним файлом исходного кода: program.cs.

Установите клиентскую библиотеку, щелкнув правой кнопкой мыши решение в обозревателе решений и выбрав Управление пакетами NuGet. В открывшемся диспетчере пакетов выберите Просмотр и выполните поиск по запросу Azure.AI.TextAnalytics. Выберите версию 5.2.0, а затем Установить. Вы также можете использовать консоль диспетчера пакетов.

Пример кода

Скопируйте следующий код в файл program.cs. Не забудьте заменить переменную key ключом для вашего ресурса, а переменную endpoint — конечной точкой для вашего ресурса. Теперь выполните код.

Внимание

Переход на портал Azure. Если языковой ресурс, созданный в соответствии с указаниями в разделе Предварительные требования, успешно развернут, нажмите кнопку Перейти к ресурсу в разделе Дальнейшие действия. Ключ и конечная точка доступны на странице Ключи и конечная точка ресурса в разделе Управление ресурсами.

Внимание

Обязательно удалите ключ из кода, когда завершите работу, и ни в коем случае не публикуйте его в открытом доступе. Для рабочей среды используйте безопасный способ хранения и доступа к учетным данным, например Azure Key Vault. Дополнительные сведения см. в статье по безопасности служб ИИ Azure.

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, которое может идентифицировать ключевые слова и фразы в тексте.

Совет

С помощью Language Studio можно опробовать функции языковой службы без написания кода.

Необходимые компоненты

  • Подписка Azure — создайте бесплатную учетную запись.
  • Пакет разработчиков Java (JDK) версии 8 или более поздней.
  • После получения подписки Azure создайте ресурс языка в портал Azure, чтобы получить ключ и конечную точку. После развертывания ресурса выберите элемент Перейти к ресурсу.
    • Чтобы подключить приложение к API, потребуется ключ и конечная точка из созданного ресурса. Ключ и конечная точка будут вставлены в приведенный ниже код в кратком руководстве.
    • Используйте бесплатную ценовую категорию (Free F0), чтобы опробовать службу, а затем выполните обновление до платного уровня для рабочей среды.
  • Чтобы использовать функцию анализа, вам потребуется языковой ресурс ценовой категории "Стандартный" (S).

Установка

Добавление клиентской библиотеки

Создайте проект Maven в предпочтительной среде разработки или IDE. Потом добавьте следующую зависимость в файл pom.xml проекта. Синтаксис реализации для других средств сборки можно найти в Интернете.

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

Пример кода

Создайте файл Java с именем Example.java. Откройте файл и скопируйте приведенный ниже код. Не забудьте заменить переменную key ключом для вашего ресурса, а переменную endpoint — конечной точкой для вашего ресурса. Теперь выполните код.

Внимание

Переход на портал Azure. Если языковой ресурс, созданный в соответствии с указаниями в разделе Предварительные требования, успешно развернут, нажмите кнопку Перейти к ресурсу в разделе Дальнейшие действия. Ключ и конечная точка доступны на странице Ключи и конечная точка ресурса в разделе Управление ресурсами.

Внимание

Обязательно удалите ключ из кода, когда завершите работу, и ни в коем случае не публикуйте его в открытом доступе. Для рабочей среды используйте безопасный способ хранения и доступа к учетным данным, например Azure Key Vault. Дополнительные сведения см. в статье по безопасности служб ИИ Azure.

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, которое может идентифицировать ключевые слова и фразы в тексте.

Совет

С помощью Language Studio можно опробовать функции языковой службы без написания кода.

Необходимые компоненты

  • Подписка Azure — создайте бесплатную учетную запись.
  • Node.js версии 14 LTS или выше
  • После получения подписки Azure создайте ресурс языка в портал Azure, чтобы получить ключ и конечную точку. После развертывания ресурса выберите элемент Перейти к ресурсу.
    • Чтобы подключить приложение к API, потребуется ключ и конечная точка из созданного ресурса. Ключ и конечная точка будут вставлены в приведенный ниже код в кратком руководстве.
    • Используйте бесплатную ценовую категорию (Free F0), чтобы опробовать службу, а затем выполните обновление до платного уровня для рабочей среды.
  • Чтобы использовать функцию анализа, вам потребуется языковой ресурс ценовой категории "Стандартный" (S).

Установка

Создание нового приложения Node.js

В окне консоли (например, cmd, PowerShell или Bash) создайте новый каталог для приложения и перейдите в него.

mkdir myapp 

cd myapp

Выполните команду npm init, чтобы создать приложение узла с помощью файла package.json.

npm init

Установка клиентской библиотеки

Установите пакет npm:

npm install @azure/ai-language-text

Пример кода

Откройте файл и скопируйте приведенный ниже код. Не забудьте заменить переменную key ключом для вашего ресурса, а переменную endpoint — конечной точкой для вашего ресурса. Теперь выполните код.

Внимание

Переход на портал Azure. Если языковой ресурс, созданный в соответствии с указаниями в разделе Предварительные требования, успешно развернут, нажмите кнопку Перейти к ресурсу в разделе Дальнейшие действия. Ключ и конечная точка доступны на странице Ключи и конечная точка ресурса в разделе Управление ресурсами.

Внимание

Обязательно удалите ключ из кода, когда завершите работу, и ни в коем случае не публикуйте его в открытом доступе. Для рабочей среды используйте безопасный способ хранения и доступа к учетным данным, например Azure Key Vault. Дополнительные сведения см. в статье по безопасности служб ИИ Azure.

"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, которое может идентифицировать ключевые слова и фразы в тексте.

Совет

С помощью Language Studio можно опробовать функции языковой службы без написания кода.

Необходимые компоненты

  • Подписка Azure — создайте бесплатную учетную запись.
  • Python 3.8 или более поздней версии
  • После получения подписки Azure создайте ресурс языка в портал Azure, чтобы получить ключ и конечную точку. После развертывания ресурса выберите элемент Перейти к ресурсу.
    • Чтобы подключить приложение к API, потребуется ключ и конечная точка из созданного ресурса. Ключ и конечная точка будут вставлены в приведенный ниже код в кратком руководстве.
    • Используйте бесплатную ценовую категорию (Free F0), чтобы опробовать службу, а затем выполните обновление до платного уровня для рабочей среды.
  • Чтобы использовать функцию анализа, вам потребуется языковой ресурс ценовой категории "Стандартный" (S).

Установка

Установка клиентской библиотеки

После установки Python вы можете установить клиентскую библиотеку с помощью следующей команды:

pip install azure-ai-textanalytics==5.2.0

Пример кода

Создайте файл Python и скопируйте код ниже. Не забудьте заменить переменную key ключом для вашего ресурса, а переменную endpoint — конечной точкой для вашего ресурса. Теперь выполните код.

Внимание

Переход на портал Azure. Если языковой ресурс, созданный в соответствии с указаниями в разделе Предварительные требования, успешно развернут, нажмите кнопку Перейти к ресурсу в разделе Дальнейшие действия. Ключ и конечная точка доступны на странице Ключи и конечная точка ресурса в разделе Управление ресурсами.

Внимание

Обязательно удалите ключ из кода, когда завершите работу, и ни в коем случае не публикуйте его в открытом доступе. Для рабочей среды используйте безопасный способ хранения и доступа к учетным данным, например Azure Key Vault. Дополнительные сведения см. в статье по безопасности служб ИИ Azure.

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, чтобы идентифицировать ключевые слова и фразы в тексте.

Совет

С помощью Language Studio можно опробовать функции языковой службы без написания кода.

Необходимые компоненты

  • Подписка Azure — создайте бесплатную учетную запись.
  • Текущая версия cURL.
  • После получения подписки Azure создайте ресурс языка в портал Azure, чтобы получить ключ и конечную точку. После развертывания ресурса выберите элемент Перейти к ресурсу.
    • Чтобы подключить приложение к API, потребуется ключ и конечная точка из созданного ресурса. Ключ и конечная точка будут вставлены в приведенный ниже код в кратком руководстве.
    • Используйте бесплатную ценовую категорию (Free F0), чтобы опробовать службу, а затем выполните обновление до платного уровня для рабочей среды.

Примечание.

  • В следующих примерах BASH используется символ продолжения строки \. Если консоль или терминал использует другой символ продолжения строки, используйте этот символ.
  • Примеры для конкретного языка можно найти на GitHub.
  • Перейдите на портал Azure и найдите ключ и конечную точку для языкового ресурса, созданного согласно предварительным требованиям. Они находятся на странице ресурса Ключ и конечная точка в разделе Управление ресурсами. Затем замените строки в приведенном ниже коде ключом и конечной точкой. Для вызова API необходимы следующие сведения:
параметр Описание
-X POST <endpoint> Указывает конечную точку для доступа к API.
-H Content-Type: application/json Тип содержимого для отправки данных JSON.
-H "Ocp-Apim-Subscription-Key:<key> Указывает ключ для доступа к API.
-d <documents> JSON с документами, которые необходимо отправить.

Приведенные ниже команды cURL выполняются из оболочки BASH. Измените эти команды, указав имя ресурса, ключ ресурса и значения 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"
	}
}

Очистка ресурсов

Если вы хотите очистить и удалить подписку на службы искусственного интеллекта Azure, можно удалить ресурс или группу ресурсов. При удалении группы ресурсов также удаляются все связанные с ней ресурсы.

Следующие шаги