Rychlý start: Použití klientské knihovny pro extrakci klíčových frází a rozhraní REST API

  • Článek

Referenční dokumentace | Další ukázkové balíčky | (NuGet) | Zdrojový kód knihovny

V tomto rychlém startu můžete vytvořit aplikaci pro extrakci klíčových frází s klientskou knihovnou pro .NET. V následujícím příkladu vytvoříte aplikaci jazyka C#, která dokáže identifikovat klíčová slova a fráze nalezené v textu.

Tip

Pomocí sady Language Studio můžete vyzkoušet funkce služby Language, aniž byste museli psát kód.

Požadavky

  • Předplatné Azure: Můžete si ho vytvořit zdarma.
  • Integrované vývojové prostředí (IDE) sady Visual Studio
  • Jakmile budete mít předplatné Azure, vytvořte prostředek jazyka na webu Azure Portal, abyste získali klíč a koncový bod. Po nasazení vyberte Přejít k prostředku.
    • K připojení aplikace k rozhraní API budete potřebovat klíč a koncový bod z prostředku, který vytvoříte. Klíč a koncový bod vložíte do kódu níže v rychlém startu.
    • K vyzkoušení služby můžete použít cenovou úroveňFree F0 Free a později upgradovat na placenou úroveň pro produkční prostředí.
  • Pokud chcete použít funkci Analyzovat, budete potřebovat prostředek jazyka s cenovou úrovní Standard (S).

Nastavení

Vytvoření nové aplikace .NET Core

Pomocí integrovaného vývojového prostředí (IDE) sady Visual Studio vytvořte novou aplikaci konzoly .NET Core. Vytvoří se projekt Hello World s jedním zdrojovým souborem jazyka C#: program.cs.

Klikněte pravým tlačítkem na řešení v Průzkumníku řešení, vyberte Spravovat balíčky NuGet a nainstalujte klientskou knihovnu. Ve správci balíčků, který se otevře, vyberte Procházet a vyhledejte Azure.AI.TextAnalytics. Vyberte verzi 5.2.0 a pak vyberte Nainstalovat. Můžete použít také konzolu správce balíčků.

Příklad kódu

Do souboru program.cs zkopírujte následující kód. Nezapomeňte nahradit key proměnnou klíčem pro váš prostředek a nahradit endpoint proměnnou koncovým bodem vašeho prostředku. Potom kód spusťte.

Důležité

Přejděte na Azure Portal. Pokud se prostředek jazyka, který jste vytvořili v části Požadavky, úspěšně nasadil, klikněte v části Další kroky na tlačítko Přejít k prostředku. Klíč a koncový bod najdete tak, že přejdete na stránku Klíče a koncový bod vašeho prostředku v části Správa prostředků.

Důležité

Nezapomeňte klíč z kódu odebrat, až to budete hotovi, a nikdy ho veřejně neposílejte. V produkčním prostředí použijte bezpečný způsob ukládání přihlašovacích údajů a přístupu k vašim přihlašovacím údajům, jako je Azure Key Vault. Další informace najdete v článku zabezpečení služeb 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();
        }

    }
}

Výstup

Key phrases:
    modern medical office
    Dr. Smith
    great staff

Referenční dokumentace | Další ukázkové balíčky | (Maven) | Zdrojový kód knihovny

V tomto rychlém startu můžete vytvořit aplikaci pro extrakci klíčových frází s klientskou knihovnou pro Javu. V následujícím příkladu vytvoříte aplikaci v Javě, která dokáže identifikovat klíčová slova a fráze nalezené v textu.

Tip

Pomocí sady Language Studio můžete vyzkoušet funkce služby Language, aniž byste museli psát kód.

Požadavky

  • Předplatné Azure: Můžete si ho vytvořit zdarma.
  • Java Development Kit (JDK) verze 8 nebo novější
  • Jakmile budete mít předplatné Azure, vytvořte prostředek jazyka na webu Azure Portal, abyste získali klíč a koncový bod. Po nasazení vyberte Přejít k prostředku.
    • K připojení aplikace k rozhraní API budete potřebovat klíč a koncový bod z prostředku, který vytvoříte. Klíč a koncový bod vložíte do kódu níže v rychlém startu.
    • K vyzkoušení služby můžete použít cenovou úroveňFree F0 Free a později upgradovat na placenou úroveň pro produkční prostředí.
  • Pokud chcete použít funkci Analyzovat, budete potřebovat prostředek jazyka s cenovou úrovní Standard (S).

Nastavení

Přidání klientské knihovny

V oblíbeném vývojovém prostředí nebo integrovaném vývojovém prostředí (IDE) vytvořte projekt Maven. Pak do souboru pom.xml projektu přidejte následující závislost. Syntaxi pro implementaci pro další nástroje pro sestavování najdete online.

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

Příklad kódu

Vytvořte soubor Java s názvem Example.java. Otevřete soubor a zkopírujte následující kód. Nezapomeňte nahradit key proměnnou klíčem pro váš prostředek a nahradit endpoint proměnnou koncovým bodem vašeho prostředku. Potom kód spusťte.

Důležité

Přejděte na Azure Portal. Pokud se prostředek jazyka, který jste vytvořili v části Požadavky, úspěšně nasadil, klikněte v části Další kroky na tlačítko Přejít k prostředku. Klíč a koncový bod najdete tak, že přejdete na stránku Klíče a koncový bod vašeho prostředku v části Správa prostředků.

Důležité

Nezapomeňte klíč z kódu odebrat, až to budete hotovi, a nikdy ho veřejně neposílejte. V produkčním prostředí použijte bezpečný způsob ukládání přihlašovacích údajů a přístupu k vašim přihlašovacím údajům, jako je Azure Key Vault. Další informace najdete v článku zabezpečení služeb Azure AI.

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

Výstup

Recognized phrases: 

modern medical office
Dr. Smith
great staff

Referenční dokumentace | Další ukázkové balíčky | (npm) | Zdrojový kód knihovny

V tomto rychlém startu můžete vytvořit aplikaci pro extrakci klíčových frází s klientskou knihovnou pro Node.js. V následujícím příkladu vytvoříte javascriptovou aplikaci, která dokáže identifikovat klíčová slova a fráze nalezené v textu.

Tip

Pomocí sady Language Studio můžete vyzkoušet funkce služby Language, aniž byste museli psát kód.

Požadavky

  • Předplatné Azure: Můžete si ho vytvořit zdarma.
  • Node.js verze 14 LTS nebo novější
  • Jakmile budete mít předplatné Azure, vytvořte prostředek jazyka na webu Azure Portal, abyste získali klíč a koncový bod. Po nasazení vyberte Přejít k prostředku.
    • K připojení aplikace k rozhraní API budete potřebovat klíč a koncový bod z prostředku, který vytvoříte. Klíč a koncový bod vložíte do kódu níže v rychlém startu.
    • K vyzkoušení služby můžete použít cenovou úroveňFree F0 Free a později upgradovat na placenou úroveň pro produkční prostředí.
  • Pokud chcete použít funkci Analyzovat, budete potřebovat prostředek jazyka s cenovou úrovní Standard (S).

Nastavení

Vytvoření nové aplikace Node.js

V okně konzoly (například cmd, PowerShell nebo Bash) vytvořte pro vaši aplikaci nový adresář a přejděte do něj.

mkdir myapp 

cd myapp

Spuštěním příkazu npm init vytvoříte aplikaci uzlu se souborem package.json.

npm init

Instalace klientské knihovny

Nainstalujte balíček npm:

npm install @azure/ai-language-text

Příklad kódu

Otevřete soubor a zkopírujte následující kód. Nezapomeňte nahradit key proměnnou klíčem pro váš prostředek a nahradit endpoint proměnnou koncovým bodem vašeho prostředku. Potom kód spusťte.

Důležité

Přejděte na Azure Portal. Pokud se prostředek jazyka, který jste vytvořili v části Požadavky, úspěšně nasadil, klikněte v části Další kroky na tlačítko Přejít k prostředku. Klíč a koncový bod najdete tak, že přejdete na stránku Klíče a koncový bod vašeho prostředku v části Správa prostředků.

Důležité

Nezapomeňte klíč z kódu odebrat, až to budete hotovi, a nikdy ho veřejně neposílejte. V produkčním prostředí použijte bezpečný způsob ukládání přihlašovacích údajů a přístupu k vašim přihlašovacím údajům, jako je Azure Key Vault. Další informace najdete v článku zabezpečení služeb Azure AI.

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

Výstup

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

Referenční dokumentace | Další ukázkové balíčky | (PyPi) | Zdrojový kód knihovny

V tomto rychlém startu můžete vytvořit aplikaci pro extrakci klíčových frází pomocí klientské knihovny pro Python. V následujícím příkladu vytvoříte aplikaci Pythonu, která dokáže identifikovat klíčová slova a fráze nalezené v textu.

Tip

Pomocí sady Language Studio můžete vyzkoušet funkce služby Language, aniž byste museli psát kód.

Požadavky

  • Předplatné Azure: Můžete si ho vytvořit zdarma.
  • Python 3.8 nebo novější
  • Jakmile budete mít předplatné Azure, vytvořte prostředek jazyka na webu Azure Portal, abyste získali klíč a koncový bod. Po nasazení vyberte Přejít k prostředku.
    • K připojení aplikace k rozhraní API budete potřebovat klíč a koncový bod z prostředku, který vytvoříte. Klíč a koncový bod vložíte do kódu níže v rychlém startu.
    • K vyzkoušení služby můžete použít cenovou úroveňFree F0 Free a později upgradovat na placenou úroveň pro produkční prostředí.
  • Pokud chcete použít funkci Analyzovat, budete potřebovat prostředek jazyka s cenovou úrovní Standard (S).

Nastavení

Instalace klientské knihovny

Po instalaci Pythonu můžete nainstalovat klientskou knihovnu pomocí:

pip install azure-ai-textanalytics==5.2.0

Příklad kódu

Vytvořte nový soubor Pythonu a zkopírujte následující kód. Nezapomeňte nahradit key proměnnou klíčem pro váš prostředek a nahradit endpoint proměnnou koncovým bodem vašeho prostředku. Potom kód spusťte.

Důležité

Přejděte na Azure Portal. Pokud se prostředek jazyka, který jste vytvořili v části Požadavky, úspěšně nasadil, klikněte v části Další kroky na tlačítko Přejít k prostředku. Klíč a koncový bod najdete tak, že přejdete na stránku Klíče a koncový bod vašeho prostředku v části Správa prostředků.

Důležité

Nezapomeňte klíč z kódu odebrat, až to budete hotovi, a nikdy ho veřejně neposílejte. V produkčním prostředí použijte bezpečný způsob ukládání přihlašovacích údajů a přístupu k vašim přihlašovacím údajům, jako je Azure Key Vault. Další informace najdete v článku zabezpečení služeb Azure AI.

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)

Výstup

Key Phrases:
    modern medical office
    Dr. Smith
    great staff

Referenční dokumentace

Pomocí tohoto rychlého startu můžete odesílat žádosti o extrakci klíčových frází pomocí rozhraní REST API. V následujícím příkladu použijete cURL k identifikaci klíčových slov a frází nalezených v textu.

Tip

Pomocí sady Language Studio můžete vyzkoušet funkce služby Language, aniž byste museli psát kód.

Požadavky

  • Předplatné Azure: Můžete si ho vytvořit zdarma.
  • Aktuální verze cURL.
  • Jakmile budete mít předplatné Azure, vytvořte prostředek jazyka na webu Azure Portal, abyste získali klíč a koncový bod. Po nasazení vyberte Přejít k prostředku.
    • K připojení aplikace k rozhraní API budete potřebovat klíč a koncový bod z prostředku, který vytvoříte. Klíč a koncový bod vložíte do kódu níže v rychlém startu.
    • K vyzkoušení služby můžete použít cenovou úroveňFree F0 Free a později upgradovat na placenou úroveň pro produkční prostředí.

Poznámka:

  • Následující příklady BASH používají \ znak pokračování řádku. Pokud konzola nebo terminál používá jiný znak pokračování řádku, použijte tento znak.
  • Ukázky specifické pro jazyk najdete na GitHubu.
  • Přejděte na web Azure Portal a vyhledejte klíč a koncový bod pro prostředek jazyka, který jste vytvořili v požadavcích. Budou umístěny na stránce klíče a koncového bodu prostředku v rámci správy prostředků. Potom nahraďte řetězce v následujícím kódu klíčem a koncovým bodem. K volání rozhraní API potřebujete následující informace:
parametr Popis
-X POST <endpoint> Určuje koncový bod pro přístup k rozhraní API.
-H Content-Type: application/json Typ obsahu pro odesílání dat JSON.
-H "Ocp-Apim-Subscription-Key:<key> Určuje klíč pro přístup k rozhraní API.
-d <documents> JSON obsahující dokumenty, které chcete odeslat.

Následující příkazy cURL se spouští z prostředí BASH. Tyto příkazy můžete upravit pomocí vlastního názvu prostředku, klíče prostředku a hodnot JSON.

Extrakce klíčových frází

  1. Zkopírujte příkaz do textového editoru.
  2. V příkazu proveďte v případě potřeby následující změny:
    1. Nahraďte hodnotu <your-language-resource-key> klíčem.
    2. Nahraďte první část adresy URL požadavku adresou URL <your-language-resource-endpoint> koncového bodu.
  3. Otevřete okno příkazového řádku.
  4. Vložte příkaz z textového editoru do okna příkazového řádku a pak příkaz spusťte.
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."
            }
        ]
    }
}
'

Odpověď JSON

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

Vyčištění prostředků

Pokud chcete vyčistit a odebrat předplatné služeb Azure AI, můžete odstranit prostředek nebo skupinu prostředků. Odstraněním skupiny prostředků se odstraní také všechny ostatní prostředky, které jsou k ní přidružené.

Další kroky