Quickstart: de clientbibliotheek voor sleuteltermextractie en REST API gebruiken

Artikel
03/19/2024

Referentiedocumentatie Aanvullende voorbeeldenpakket | (NuGet) | Bibliotheekbroncode |

Gebruik deze quickstart om een sleuteltermextractietoepassing te maken met de clientbibliotheek voor .NET. In het volgende voorbeeld maakt u een C#-toepassing waarmee sleutelwoorden en woordgroepen in tekst kunnen worden geïdentificeerd.

Tip

U kunt Language Studio gebruiken om taalservicefuncties te proberen zonder code te hoeven schrijven.

Vereisten

Azure-abonnement: Krijg een gratis abonnement
De Visual Studio IDE
Zodra u uw Azure-abonnement hebt, maakt u een taalresource in Azure Portal om uw sleutel en eindpunt op te halen. Nadat de app is geïmplementeerd, selecteert u Ga naar resource.
- U hebt de sleutel en het eindpunt nodig van de resource die u maakt om uw toepassing te verbinden met de API. Later in de quickstart plakt u uw sleutel en eindpunt in de onderstaande code.
- U kunt de gratis prijscategorie (Free F0) gebruiken om de service uit te proberen, en later upgraden naar een betaalde laag voor productie.
Als u de functie Analyseren wilt gebruiken, hebt u een taalresource nodig met de prijscategorie Standard (S).

Instellen

Een nieuwe .NET Core-app maken

Maak een nieuwe console-app in .NET Core met behulp van de Visual Studio IDE. Hiermee wordt een Hello World-project gemaakt met één bronbestand van C#: program.cs.

Installeer de clientbibliotheek door met de rechtermuisknop op de oplossing te klikken in Solution Explorer en NuGet-pakketten beheren te selecteren. Selecteer in Package Manager dat wordt geopend de optie Bladeren en zoek naar Azure.AI.TextAnalytics. Selecteer versie 5.2.0 en vervolgens Installeren. U kunt ook de Package Manager-console gebruiken.

Voorbeeld van code

Kopieer de volgende code naar uw program.cs-bestand . Vergeet niet om de key variabele te vervangen door de sleutel voor uw resource en vervang de endpoint variabele door het eindpunt voor uw resource. Voer de code vervolgens uit.

Belangrijk

Ga naar de Azure-portal. Als de taalresource die u in de sectie Vereisten hebt gemaakt, is geïmplementeerd, klikt u op de knop Naar de resource gaan onder Volgende stappen. U vindt uw sleutel en eindpunt door te navigeren naar de pagina Sleutels en eindpunt van uw resource, onder Resourcebeheer.

Belangrijk

Vergeet niet de sleutel uit uw code te verwijderen wanneer u klaar bent, en maak deze sleutel nooit openbaar. Gebruik voor productie een veilige manier om uw referenties op te slaan en te openen, zoals Azure Key Vault. Zie het beveiligingsartikel over Azure AI-services voor meer informatie.

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

    }
}

Uitvoer

Key phrases:
    modern medical office
    Dr. Smith
    great staff

Referentiedocumentatie Aanvullende voorbeeldenpakket | (Maven) | Library-broncode |

Gebruik deze quickstart om een sleuteltermextractietoepassing te maken met de clientbibliotheek voor Java. In het volgende voorbeeld maakt u een Java-toepassing waarmee sleutelwoorden en woordgroepen in tekst kunnen worden geïdentificeerd.

Tip

U kunt Language Studio gebruiken om taalservicefuncties te proberen zonder code te hoeven schrijven.

Vereisten

Azure-abonnement: Krijg een gratis abonnement
Java Development Kit (JDK) met versie 8 of hoger
Zodra u uw Azure-abonnement hebt, maakt u een taalresource in Azure Portal om uw sleutel en eindpunt op te halen. Nadat de app is geïmplementeerd, selecteert u Ga naar resource.
- U hebt de sleutel en het eindpunt nodig van de resource die u maakt om uw toepassing te verbinden met de API. Later in de quickstart plakt u uw sleutel en eindpunt in de onderstaande code.
- U kunt de gratis prijscategorie (Free F0) gebruiken om de service uit te proberen, en later upgraden naar een betaalde laag voor productie.
Als u de functie Analyseren wilt gebruiken, hebt u een taalresource nodig met de prijscategorie Standard (S).

Instellen

De clientbibliotheek toevoegen

Maak een Maven-project in uw favoriete IDE of ontwikkelomgeving. Voeg vervolgens de volgende afhankelijkheid toe aan het pom.xml-bestand van uw project. U kunt de implementatiesyntaxis voor andere compilatieprogramma's online vinden.

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

Voorbeeld van code

Maak een Java-bestand met de naam Example.java. Open het bestand en kopieer de onderstaande code. Vergeet niet om de key variabele te vervangen door de sleutel voor uw resource en vervang de endpoint variabele door het eindpunt voor uw resource. Voer de code vervolgens uit.

Belangrijk

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

Uitvoer

Recognized phrases: 

modern medical office
Dr. Smith
great staff

Referentiedocumentatie Aanvullende voorbeeldenpakket | (npm) | Bibliotheekbroncode |

Gebruik deze quickstart om een sleuteltermextractietoepassing te maken met de clientbibliotheek voor Node.js. In het volgende voorbeeld maakt u een JavaScript-toepassing waarmee sleutelwoorden en woordgroepen in tekst kunnen worden geïdentificeerd.

Tip

U kunt Language Studio gebruiken om taalservicefuncties te proberen zonder code te hoeven schrijven.

Vereisten

Azure-abonnement: Krijg een gratis abonnement
Node.js v14 LTS of hoger
Zodra u uw Azure-abonnement hebt, maakt u een taalresource in Azure Portal om uw sleutel en eindpunt op te halen. Nadat de app is geïmplementeerd, selecteert u Ga naar resource.
- U hebt de sleutel en het eindpunt nodig van de resource die u maakt om uw toepassing te verbinden met de API. Later in de quickstart plakt u uw sleutel en eindpunt in de onderstaande code.
- U kunt de gratis prijscategorie (Free F0) gebruiken om de service uit te proberen, en later upgraden naar een betaalde laag voor productie.
Als u de functie Analyseren wilt gebruiken, hebt u een taalresource nodig met de prijscategorie Standard (S).

Instellen

Een nieuwe Node.js-toepassing maken

Maak in een consolevenster (zoals cmd, PowerShell of Bash) een nieuwe map voor de app, en navigeer naar deze map.

mkdir myapp 

cd myapp

Voer de opdracht npm init uit om een knooppunttoepassing te maken met een package.json-bestand.

npm init

De clientbibliotheek installeren

Installeer het npm-pakket:

npm install @azure/ai-language-text

Voorbeeld van code

Open het bestand en kopieer de onderstaande code. Vergeet niet om de key variabele te vervangen door de sleutel voor uw resource en vervang de endpoint variabele door het eindpunt voor uw resource. Voer de code vervolgens uit.

Belangrijk

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

Uitvoer

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

Referentiedocumentatie Aanvullende voorbeeldenpakket | (PyPi) | Library-broncode |

Gebruik deze quickstart om een sleuteltermextractietoepassing te maken met de clientbibliotheek voor Python. In het volgende voorbeeld maakt u een Python-toepassing waarmee sleutelwoorden en woordgroepen in tekst kunnen worden geïdentificeerd.

Tip

U kunt Language Studio gebruiken om taalservicefuncties te proberen zonder code te hoeven schrijven.

Vereisten

Azure-abonnement: Krijg een gratis abonnement
Python 3.8 of hoger
Zodra u uw Azure-abonnement hebt, maakt u een taalresource in Azure Portal om uw sleutel en eindpunt op te halen. Nadat de app is geïmplementeerd, selecteert u Ga naar resource.
- U hebt de sleutel en het eindpunt nodig van de resource die u maakt om uw toepassing te verbinden met de API. Later in de quickstart plakt u uw sleutel en eindpunt in de onderstaande code.
- U kunt de gratis prijscategorie (Free F0) gebruiken om de service uit te proberen, en later upgraden naar een betaalde laag voor productie.
Als u de functie Analyseren wilt gebruiken, hebt u een taalresource nodig met de prijscategorie Standard (S).

Instellen

De clientbibliotheek installeren

Na de installatie van Python kunt u de clientbibliotheek installeren met:

pip install azure-ai-textanalytics==5.2.0

Voorbeeld van code

Maak een nieuw Python-bestand en kopieer de onderstaande code. Vergeet niet om de key variabele te vervangen door de sleutel voor uw resource en vervang de endpoint variabele door het eindpunt voor uw resource. Voer de code vervolgens uit.

Belangrijk

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)

Uitvoer

Key Phrases:
    modern medical office
    Dr. Smith
    great staff

Referentiedocumentatie

Gebruik deze quickstart om sleuteltermextractieaanvragen te verzenden met behulp van de REST API. In het volgende voorbeeld gebruikt u cURL om sleutelwoorden en woordgroepen in tekst te identificeren.

Tip

U kunt Language Studio gebruiken om taalservicefuncties te proberen zonder code te hoeven schrijven.

Vereisten

Azure-abonnement: Krijg een gratis abonnement
De huidige versie van cURL.
Zodra u uw Azure-abonnement hebt, maakt u een taalresource in Azure Portal om uw sleutel en eindpunt op te halen. Nadat de app is geïmplementeerd, selecteert u Ga naar resource.
- U hebt de sleutel en het eindpunt nodig van de resource die u maakt om uw toepassing te verbinden met de API. Later in de quickstart plakt u uw sleutel en eindpunt in de onderstaande code.
- U kunt de gratis prijscategorie (Free F0) gebruiken om de service uit te proberen, en later upgraden naar een betaalde laag voor productie.

Notitie

In de volgende BASH-voorbeelden wordt het regelvoortzettingsteken \ gebruikt. Als in de console of terminal een ander regelvoortzettingsteken wordt gebruikt, gebruikt u dat teken.
U kunt taalspecifieke voorbeelden vinden op GitHub (Engelstalig).
Ga naar Azure Portal en zoek de sleutel en het eindpunt voor de taalresource die u hebt gemaakt in de vereisten. U vindt deze op de pagina Sleutel en eindpunt van de resource, onder Resourcebeheer. Vervang de tekenreeksen in de onderstaande code door uw sleutel en eindpunt. Als u de API wilt aanroepen, hebt u de volgende informatie nodig:

parameter	Description
`-X POST <endpoint>`	Hiermee geeft u het eindpunt voor toegang tot de API op.
`-H Content-Type: application/json`	Het inhoudstype voor het verzenden van JSON-gegevens.
`-H "Ocp-Apim-Subscription-Key:<key>`	Hiermee geeft u de sleutel voor toegang tot de API op.
`-d <documents>`	De JSON met de documenten die u wilt verzenden.

De volgende cURL-opdrachten worden uitgevoerd vanuit een Bash-shell. Bewerk deze opdrachten met uw eigen resourcenaam, resourcesleutel en JSON-waarden.

Sleuteltermextractie

Kopieer de opdracht in een teksteditor.
Breng waar nodig de volgende wijzigingen aan in de opdracht:
1. Vervang de waarde van <your-language-resource-key> door uw sleutel.
2. Vervang het eerste deel van de aanvraag-URL <your-language-resource-endpoint> door uw eindpunt-URL.
Open een opdrachtpromptvenster.
Plak de opdracht van de teksteditor in het opdrachtpromptvenster en voer de opdracht uit.

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-antwoord

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

Resources opschonen

Als u een Azure AI-servicesabonnement wilt opschonen en verwijderen, kunt u de resource of resourcegroep verwijderen. Als u de resourcegroep verwijdert, worden ook alle bijbehorende resources verwijderd.

Volgende stappen

Overzicht van sleuteltermextractie

Quickstart: de clientbibliotheek voor sleuteltermextractie en REST API gebruiken

Vereisten

Instellen

Een nieuwe .NET Core-app maken

Voorbeeld van code

Uitvoer

Vereisten

Instellen

De clientbibliotheek toevoegen

Voorbeeld van code

Uitvoer

Vereisten

Instellen

Een nieuwe Node.js-toepassing maken

De clientbibliotheek installeren

Voorbeeld van code

Uitvoer

Vereisten

Instellen

De clientbibliotheek installeren

Voorbeeld van code

Uitvoer

Vereisten

Sleuteltermextractie

JSON-antwoord

Resources opschonen

Volgende stappen

Aanvullende resources