Szybki start: korzystanie z biblioteki klienta wyodrębniania kluczowych fraz i interfejsu API REST

Artykuł
03/15/2024

Dokumentacja referencyjna Dodatkowe przykłady | Package (NuGet) | Kod źródłowy biblioteki |

Użyj tego przewodnika Szybki start, aby utworzyć aplikację wyodrębniania kluczowych fraz z biblioteką klienta dla platformy .NET. W poniższym przykładzie utworzysz aplikację w języku C#, która będzie mogła identyfikować kluczowe słowa i frazy znalezione w tekście.

Napiwek

Możesz użyć programu Language Studio , aby wypróbować funkcje usługi językowej bez konieczności pisania kodu.

Wymagania wstępne

Subskrypcja platformy Azure — utwórz bezpłatnie
Środowisko IDE programu Visual Studio
Po utworzeniu subskrypcji platformy Azure utwórz zasób language w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy. Po wdrożeniu wybierz pozycję Przejdź do zasobu.
- Potrzebny będzie klucz i punkt końcowy z utworzonego zasobu, aby połączyć aplikację z interfejsem API. W dalszej części przewodnika Szybki start wklejesz klucz i punkt końcowy do poniższego kodu.
- Możesz użyć warstwy cenowej bezpłatna (Free F0), aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.
Aby użyć funkcji Analizuj, potrzebny będzie zasób język ze standardową warstwą cenową (S).

Konfigurowanie

Tworzenie nowej aplikacji .NET Core

Za pomocą środowiska IDE programu Visual Studio utwórz nową aplikację konsolową platformy .NET Core. Spowoduje to utworzenie projektu „Hello world” z pojedynczym plikiem źródłowym C#: program.cs.

Zainstaluj bibliotekę klienta, klikając prawym przyciskiem myszy rozwiązanie w Eksploratorze rozwiązań i wybierając polecenie Zarządzaj pakietami NuGet. W menedżerze pakietów, który zostanie otwarty, wybierz pozycję Przeglądaj i wyszukaj ciąg Azure.AI.TextAnalytics. Wybierz wersję 5.2.0, a następnie pozycję Zainstaluj. Możesz również użyć konsoli menedżera pakietów.

Przykład kodu

Skopiuj następujący kod do pliku program.cs . Pamiętaj, aby zastąpić zmienną key kluczem zasobu i zastąpić endpoint zmienną punktem końcowym zasobu. Następnie uruchom kod.

Ważne

Przejdź do portalu Azure Portal. Jeśli zasób języka utworzony w sekcji Wymagania wstępne został wdrożony pomyślnie, kliknij przycisk Przejdź do zasobu w obszarze Następne kroki. Klucz i punkt końcowy można znaleźć, przechodząc do strony Klucze i punkt końcowy zasobu w obszarze Zarządzanie zasobami.

Ważne

Pamiętaj, aby usunąć klucz z kodu po zakończeniu i nigdy nie publikować go publicznie. W przypadku środowiska produkcyjnego użyj bezpiecznego sposobu przechowywania i uzyskiwania dostępu do poświadczeń, takich jak usługa Azure Key Vault. Aby uzyskać więcej informacji, zobacz artykuł Dotyczący zabezpieczeń usług Azure AI.

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();
        }

    }
}

Wyjście

Key phrases:
    modern medical office
    Dr. Smith
    great staff

Dokumentacja referencyjna Dodatkowe przykłady | Package (Maven) | Library source code |

Użyj tego przewodnika Szybki start, aby utworzyć aplikację wyodrębniania kluczowych fraz z biblioteką klienta dla języka Java. W poniższym przykładzie utworzysz aplikację Java, która będzie mogła identyfikować kluczowe słowa i frazy znalezione w tekście.

Napiwek

Możesz użyć programu Language Studio , aby wypróbować funkcje usługi językowej bez konieczności pisania kodu.

Wymagania wstępne

Subskrypcja platformy Azure — utwórz bezpłatnie
Zestaw Java Development Kit (JDK) w wersji 8 lub nowszej
Po utworzeniu subskrypcji platformy Azure utwórz zasób language w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy. Po wdrożeniu wybierz pozycję Przejdź do zasobu.
- Potrzebny będzie klucz i punkt końcowy z utworzonego zasobu, aby połączyć aplikację z interfejsem API. W dalszej części przewodnika Szybki start wklejesz klucz i punkt końcowy do poniższego kodu.
- Możesz użyć warstwy cenowej bezpłatna (Free F0), aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.
Aby użyć funkcji Analizuj, potrzebny będzie zasób język ze standardową warstwą cenową (S).

Konfigurowanie

Dodawanie biblioteki klienta

Utwórz projekt Maven w preferowanym środowisku IDE lub w środowisku deweloperskim. Następnie dodaj następującą zależność do pliku pom.xml projektu. Składnię implementacji dla innych narzędzi kompilacji można znaleźć w Internecie.

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

Przykład kodu

Utwórz plik Java o nazwie Example.java. Otwórz plik i skopiuj poniższy kod. Pamiętaj, aby zastąpić zmienną key kluczem zasobu i zastąpić endpoint zmienną punktem końcowym zasobu. Następnie uruchom kod.

Ważne

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);
        }
    }
}

Wyjście

Recognized phrases: 

modern medical office
Dr. Smith
great staff

Dokumentacja referencyjna Dodatkowe przykłady | Package (npm) | Kod źródłowy biblioteki |

Użyj tego przewodnika Szybki start, aby utworzyć aplikację wyodrębniania kluczowych fraz z biblioteką klienta dla Node.js. W poniższym przykładzie utworzysz aplikację JavaScript, która będzie mogła identyfikować kluczowe słowa i frazy znalezione w tekście.

Napiwek

Możesz użyć programu Language Studio , aby wypróbować funkcje usługi językowej bez konieczności pisania kodu.

Wymagania wstępne

Subskrypcja platformy Azure — utwórz bezpłatnie
Node.js wersji 14 LTS lub nowszej
Po utworzeniu subskrypcji platformy Azure utwórz zasób language w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy. Po wdrożeniu wybierz pozycję Przejdź do zasobu.
- Potrzebny będzie klucz i punkt końcowy z utworzonego zasobu, aby połączyć aplikację z interfejsem API. W dalszej części przewodnika Szybki start wklejesz klucz i punkt końcowy do poniższego kodu.
- Możesz użyć warstwy cenowej bezpłatna (Free F0), aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.
Aby użyć funkcji Analizuj, potrzebny będzie zasób język ze standardową warstwą cenową (S).

Konfigurowanie

Tworzenie nowej aplikacji Node.js

W oknie konsoli (na przykład cmd, PowerShell lub Bash) utwórz nowy katalog dla aplikacji i przejdź do niego.

mkdir myapp 

cd myapp

Uruchom polecenie npm init, aby utworzyć aplikację Node przy użyciu pliku package.json.

npm init

Instalowanie biblioteki klienta

Zainstaluj pakiet npm:

npm install @azure/ai-language-text

Przykład kodu

Otwórz plik i skopiuj poniższy kod. Pamiętaj, aby zastąpić zmienną key kluczem zasobu i zastąpić endpoint zmienną punktem końcowym zasobu. Następnie uruchom kod.

Ważne

"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);
  });

Wyjście

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

Dokumentacja referencyjna Dodatkowe przykłady | Package (PyPi) | Kod źródłowy biblioteki |

Użyj tego przewodnika Szybki start, aby utworzyć aplikację wyodrębniania kluczowych fraz z biblioteką klienta dla języka Python. W poniższym przykładzie utworzysz aplikację w języku Python, która będzie mogła identyfikować kluczowe słowa i frazy znalezione w tekście.

Napiwek

Możesz użyć programu Language Studio , aby wypróbować funkcje usługi językowej bez konieczności pisania kodu.

Wymagania wstępne

Subskrypcja platformy Azure — utwórz bezpłatnie
Środowisko Python w wersji 3.8 lub nowszej
Po utworzeniu subskrypcji platformy Azure utwórz zasób language w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy. Po wdrożeniu wybierz pozycję Przejdź do zasobu.
- Potrzebny będzie klucz i punkt końcowy z utworzonego zasobu, aby połączyć aplikację z interfejsem API. W dalszej części przewodnika Szybki start wklejesz klucz i punkt końcowy do poniższego kodu.
- Możesz użyć warstwy cenowej bezpłatna (Free F0), aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.
Aby użyć funkcji Analizuj, potrzebny będzie zasób język ze standardową warstwą cenową (S).

Konfigurowanie

Instalowanie biblioteki klienta

Po zainstalowaniu środowiska Python możesz zainstalować bibliotekę klienta przy użyciu następującego polecenia:

pip install azure-ai-textanalytics==5.2.0

Przykład kodu

Utwórz nowy plik języka Python i skopiuj poniższy kod. Pamiętaj, aby zastąpić zmienną key kluczem zasobu i zastąpić endpoint zmienną punktem końcowym zasobu. Następnie uruchom kod.

Ważne

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)

Wyjście

Key Phrases:
    modern medical office
    Dr. Smith
    great staff

Dokumentacja referencyjna

Użyj tego przewodnika Szybki start, aby wysyłać żądania wyodrębniania kluczowych fraz przy użyciu interfejsu API REST. W poniższym przykładzie użyjesz biblioteki cURL do identyfikowania kluczowych słów i fraz znalezionych w tekście.

Napiwek

Możesz użyć programu Language Studio , aby wypróbować funkcje usługi językowej bez konieczności pisania kodu.

Wymagania wstępne

Subskrypcja platformy Azure — utwórz bezpłatnie
Bieżąca wersja programu cURL.
Po utworzeniu subskrypcji platformy Azure utwórz zasób language w witrynie Azure Portal, aby uzyskać klucz i punkt końcowy. Po wdrożeniu wybierz pozycję Przejdź do zasobu.
- Potrzebny będzie klucz i punkt końcowy z utworzonego zasobu, aby połączyć aplikację z interfejsem API. W dalszej części przewodnika Szybki start wklejesz klucz i punkt końcowy do poniższego kodu.
- Możesz użyć warstwy cenowej bezpłatna (Free F0), aby wypróbować usługę, a następnie uaktualnić ją do warstwy płatnej dla środowiska produkcyjnego.

Uwaga

W poniższych przykładach powłoki BASH użyto \ znaku kontynuacji wiersza. Jeśli konsola lub terminal używa innego znaku kontynuacji wiersza, użyj tego znaku.
Przykłady specyficzne dla języka można znaleźć w witrynie GitHub.
Przejdź do witryny Azure Portal i znajdź klucz i punkt końcowy zasobu Language utworzonego w wymaganiach wstępnych. Będą one znajdować się na stronie klucza zasobu i punktu końcowego w obszarze zarządzanie zasobami. Następnie zastąp ciągi w poniższym kodzie kluczem i punktem końcowym. Aby wywołać interfejs API, potrzebne są następujące informacje:

parametr	Opis
`-X POST <endpoint>`	Określa punkt końcowy na potrzeby uzyskiwania dostępu do interfejsu API.
`-H Content-Type: application/json`	Typ zawartości do wysyłania danych JSON.
`-H "Ocp-Apim-Subscription-Key:<key>`	Określa klucz dostępu do interfejsu API.
`-d <documents>`	Kod JSON zawierający dokumenty, które chcesz wysłać.

Następujące polecenia cURL są wykonywane z powłoki BASH. Edytuj te polecenia przy użyciu własnych nazw zasobów, klucza zasobu i wartości JSON.

Wyodrębnianie kluczowych fraz

Skopiuj polecenie do edytora tekstów.
W razie potrzeby wprowadź następujące zmiany w poleceniu:
1. Zastąp wartość <your-language-resource-key> kluczem.
2. Zastąp pierwszą część adresu URL żądania adresem URL <your-language-resource-endpoint> punktu końcowego.
Otwórz okno wiersza polecenia.
Wklej polecenie z edytora tekstów w oknie wiersza polecenia, a następnie uruchom polecenie.

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."
            }
        ]
    }
}
'

Odpowiedź w formacie JSON

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

Czyszczenie zasobów

Jeśli chcesz wyczyścić i usunąć subskrypcję usług Azure AI, możesz usunąć zasób lub grupę zasobów. Usunięcie grupy zasobów powoduje również usunięcie wszelkich innych skojarzonych z nią zasobów.

Następne kroki

Omówienie wyodrębniania kluczowych wyrażeń

Szybki start: korzystanie z biblioteki klienta wyodrębniania kluczowych fraz i interfejsu API REST

Wymagania wstępne

Konfigurowanie

Tworzenie nowej aplikacji .NET Core

Przykład kodu

Wyjście

Wymagania wstępne

Konfigurowanie

Dodawanie biblioteki klienta

Przykład kodu

Wyjście

Wymagania wstępne

Konfigurowanie

Tworzenie nowej aplikacji Node.js

Instalowanie biblioteki klienta

Przykład kodu

Wyjście

Wymagania wstępne

Konfigurowanie

Instalowanie biblioteki klienta

Przykład kodu

Wyjście

Wymagania wstępne

Wyodrębnianie kluczowych fraz

Odpowiedź w formacie JSON

Czyszczenie zasobów

Następne kroki

Dodatkowe zasoby