Schnellstart: Erkennen benannter Entitäten (NER)

  • Artikel

Referenzdokumentation | Weitere Beispiele | Paket (NuGet) | Quellcode der Bibliothek

Verwenden Sie diese Schnellstartanleitung, um eine Anwendung zur Erkennung benannter Entitäten (Named Entity Recognition, NER) mit der Clientbibliothek für .NET zu erstellen. Im folgenden Beispiel erstellen Sie eine C#-Anwendung, die erkannte Entitäten im Text identifizieren kann.

Tipp

Sie können Language Studio verwenden, um Sprachdienstfunktionen auszuprobieren, ohne programmieren zu müssen.

Voraussetzungen

Einrichten

Erstellen einer Azure-Ressource

Um das nachstehende Codebeispiel zu verwenden, müssen Sie eine Azure-Ressource bereitstellen. Diese Ressource enthält einen Schlüssel und Endpunkt, mit dem Sie die API-Aufrufe authentifizieren, die Sie an den Sprachdienst senden.

  1. Verwenden Sie den folgenden Link, um über das Azure-Portal eine Sprachressource zu erstellen. Sie müssen sich mit Ihrem Azure-Abonnement anmelden.

  2. Wählen Sie auf dem angezeigten Bildschirm Zusätzliche Funktionen auswählen die Option Fahren Sie fort mit dem Erstellen Ihrer Ressource aus.

    Screenshot: Optionen für zusätzliche Funktionen im Azure-Portal

  3. Geben Sie auf dem Bildschirm Sprache erstellen die folgenden Informationen an:

    Detail Beschreibung
    Subscription Das Abonnementkonto, mit dem Ihre Ressource verknüpft wird. Wählen Sie im Dropdownmenü Ihr Azure-Abonnement aus.
    Ressourcengruppe Eine Ressourcengruppe ist ein Container, der die von Ihnen erstellten Ressourcen speichert. Wählen Sie Neu erstellen aus, um eine neue Ressourcengruppe zu erstellen.
    Region Der Standort Ihrer Sprachressource Verschiedene Regionen können je nach physischem Standort Wartezeiten verursachen, haben aber keinen Einfluss auf die Laufzeitverfügbarkeit Ihrer Ressource. Wählen Sie für diesen Schnellstart entweder eine verfügbare Region in Ihrer Nähe oder USA, Osten aus.
    Name Der Name für Ihre Sprachressource. Dieser Name wird auch zum Erstellen einer Endpunkt-URL verwendet, die Ihre Anwendungen zum Senden von API-Anforderungen verwenden.
    Tarif Der Tarif für Ihre Sprachressource Sie können den Tarif Free F0 verwenden, um den Dienst zu testen, und später für die Produktion auf einen kostenpflichtigen Tarif upgraden.

    Screenshot: Details zur Ressourcenerstellung im Azure-Portal

  4. Vergewissern Sie sich, dass das Kontrollkästchen Hinweis zu verantwortungsvoller KI aktiviert ist.

  5. Wählen Sie am unteren Rand der Seite die Option Bewerten + erstellen aus.

  6. Stellen Sie auf dem angezeigten Bildschirm sicher, dass die Überprüfung erfolgreich war und dass Sie Ihre Informationen ordnungsgemäß eingegeben haben. Klicken Sie anschließend auf Erstellen.

Abrufen Ihres Schlüssels und Endpunkts

Als Nächstes benötigen Sie den Schlüssel und Endpunkt der Ressource, um Ihre Anwendung mit der API zu verbinden. Der Schlüssel und der Endpunkt werden später in der Schnellstartanleitung in den Code eingefügt.

  1. Klicken Sie nach erfolgreicher Bereitstellung der Sprachressource unter Nächste Schritte auf die Schaltfläche Zu Ressource wechseln.

    Screenshot: Nächste Schritte nach der Bereitstellung einer Ressource

  2. Wählen Sie auf dem Bildschirm für Ihre Ressource im linken Navigationsmenü die Option Schlüssel und Endpunkt aus. Sie verwenden einen Ihrer Schlüssel und Ihren Endpunkt in den folgenden Schritten.

    Screenshot: Abschnitt „Schlüssel und Endpunkt“ für eine Ressource

Erstellen von Umgebungsvariablen

Ihre Anwendung muss authentifiziert werden, um API-Anforderungen senden zu können. In der Produktionsumgebung sollten Sie eine sichere Methode zum Speichern Ihrer Anmeldeinformationen sowie zum Zugriff darauf verwenden. In diesem Beispiel schreiben Sie Ihre Anmeldeinformationen in Umgebungsvariablen auf dem lokalen Computer, auf dem die Anwendung ausgeführt wird.

Tipp

Fügen Sie den Schlüssel nicht direkt in Ihren Code ein, und machen Sie ihn nicht öffentlich. Im Artikel zur Azure KI Services-Sicherheit finden Sie weitere Authentifizierungsoptionen wie zum Beispiel Azure Key Vault.

Um die Umgebungsvariable für Ihren Sprachressourcenschlüssel festzulegen, öffnen Sie ein Konsolenfenster und befolgen die Anweisungen für Ihr Betriebssystem und Ihre Entwicklungsumgebung.

  1. Zum Festlegen der Umgebungsvariablen LANGUAGE_KEY ersetzen Sie your-key durch einen der Schlüssel für Ihre Ressource.
  2. Zum Festlegen der Umgebungsvariablen LANGUAGE_ENDPOINT ersetzen Sie your-endpoint durch den Endpunkt für Ihre Ressource.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Hinweis

Wenn Sie nur in der aktuell ausgeführten Konsole auf die Umgebungsvariable zugreifen müssen, können Sie die Umgebungsvariable mit set anstelle von setx festlegen.

Nachdem Sie die Umgebungsvariable hinzugefügt haben, müssen Sie unter Umständen alle ausgeführten Programme neu starten, von denen die Umgebungsvariablen gelesen werden müssen, z. B. das Konsolenfenster. Wenn Sie beispielsweise Visual Studio als Editor verwenden, müssen Sie Visual Studio neu starten, bevor Sie das Beispiel ausführen.

Erstellen einer neuen .NET Core-Anwendung

Erstellen Sie über die Visual Studio-IDE eine neue .NET Core-Konsolenanwendung. Dadurch wird ein Projekt vom Typ „Hallo Welt“ mit einer einzelnen C#-Quelldatei program.cs erstellt.

Installieren Sie die Clientbibliothek, indem Sie im Projektmappen-Explorer mit der rechten Maustaste auf die Projektmappe klicken und NuGet-Pakete verwalten auswählen. Wählen Sie im daraufhin geöffneten Paket-Manager die Option Durchsuchen aus, und suchen Sie nach Azure.AI.TextAnalytics. Wählen Sie die Version 5.2.0 und anschließend Installieren aus. Sie können auch die Paket-Manager-Konsole verwenden.

Codebeispiel

Kopieren Sie den folgenden Code in die Datei program.cs, und führen Sie den Code aus.

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

namespace Example
{
    class Program
    {
        // This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
        static string languageKey = Environment.GetEnvironmentVariable("LANGUAGE_KEY");
        static string languageEndpoint = Environment.GetEnvironmentVariable("LANGUAGE_ENDPOINT");

        private static readonly AzureKeyCredential credentials = new AzureKeyCredential(languageKey);
        private static readonly Uri endpoint = new Uri(languageEndpoint);
        
        // Example method for extracting named entities from text 
        static void EntityRecognitionExample(TextAnalyticsClient client)
        {
            var response = client.RecognizeEntities("I had a wonderful trip to Seattle last week.");
            Console.WriteLine("Named Entities:");
            foreach (var entity in response.Value)
            {
                Console.WriteLine($"\tText: {entity.Text},\tCategory: {entity.Category},\tSub-Category: {entity.SubCategory}");
                Console.WriteLine($"\t\tScore: {entity.ConfidenceScore:F2},\tLength: {entity.Length},\tOffset: {entity.Offset}\n");
            }
        }

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

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

    }
}

Output

Named Entities:
        Text: trip,     Category: Event,        Sub-Category:
                Score: 0.74,    Length: 4,      Offset: 18

        Text: Seattle,  Category: Location,     Sub-Category: GPE
                Score: 1.00,    Length: 7,      Offset: 26

        Text: last week,        Category: DateTime,     Sub-Category: DateRange
                Score: 0.80,    Length: 9,      Offset: 34

Referenzdokumentation | Weitere Beispiele | Paket (Maven) | Quellcode der Bibliothek

Verwenden Sie diese Schnellstartanleitung, um eine Anwendung zur Erkennung benannter Entitäten (Named Entity Recognition, NER) mit der Clientbibliothek für Java zu erstellen. Im folgenden Beispiel erstellen Sie eine Java-Anwendung, die erkannte Entitäten im Text identifizieren kann.

Voraussetzungen

Einrichten

Erstellen einer Azure-Ressource

Um das nachstehende Codebeispiel zu verwenden, müssen Sie eine Azure-Ressource bereitstellen. Diese Ressource enthält einen Schlüssel und Endpunkt, mit dem Sie die API-Aufrufe authentifizieren, die Sie an den Sprachdienst senden.

  1. Verwenden Sie den folgenden Link, um über das Azure-Portal eine Sprachressource zu erstellen. Sie müssen sich mit Ihrem Azure-Abonnement anmelden.

  2. Wählen Sie auf dem angezeigten Bildschirm Zusätzliche Funktionen auswählen die Option Fahren Sie fort mit dem Erstellen Ihrer Ressource aus.

    Screenshot: Optionen für zusätzliche Funktionen im Azure-Portal

  3. Geben Sie auf dem Bildschirm Sprache erstellen die folgenden Informationen an:

    Detail Beschreibung
    Subscription Das Abonnementkonto, mit dem Ihre Ressource verknüpft wird. Wählen Sie im Dropdownmenü Ihr Azure-Abonnement aus.
    Ressourcengruppe Eine Ressourcengruppe ist ein Container, der die von Ihnen erstellten Ressourcen speichert. Wählen Sie Neu erstellen aus, um eine neue Ressourcengruppe zu erstellen.
    Region Der Standort Ihrer Sprachressource Verschiedene Regionen können je nach physischem Standort Wartezeiten verursachen, haben aber keinen Einfluss auf die Laufzeitverfügbarkeit Ihrer Ressource. Wählen Sie für diesen Schnellstart entweder eine verfügbare Region in Ihrer Nähe oder USA, Osten aus.
    Name Der Name für Ihre Sprachressource. Dieser Name wird auch zum Erstellen einer Endpunkt-URL verwendet, die Ihre Anwendungen zum Senden von API-Anforderungen verwenden.
    Tarif Der Tarif für Ihre Sprachressource Sie können den Tarif Free F0 verwenden, um den Dienst zu testen, und später für die Produktion auf einen kostenpflichtigen Tarif upgraden.

    Screenshot: Details zur Ressourcenerstellung im Azure-Portal

  4. Vergewissern Sie sich, dass das Kontrollkästchen Hinweis zu verantwortungsvoller KI aktiviert ist.

  5. Wählen Sie am unteren Rand der Seite die Option Bewerten + erstellen aus.

  6. Stellen Sie auf dem angezeigten Bildschirm sicher, dass die Überprüfung erfolgreich war und dass Sie Ihre Informationen ordnungsgemäß eingegeben haben. Klicken Sie anschließend auf Erstellen.

Abrufen Ihres Schlüssels und Endpunkts

Als Nächstes benötigen Sie den Schlüssel und Endpunkt der Ressource, um Ihre Anwendung mit der API zu verbinden. Der Schlüssel und der Endpunkt werden später in der Schnellstartanleitung in den Code eingefügt.

  1. Klicken Sie nach erfolgreicher Bereitstellung der Sprachressource unter Nächste Schritte auf die Schaltfläche Zu Ressource wechseln.

    Screenshot: Nächste Schritte nach der Bereitstellung einer Ressource

  2. Wählen Sie auf dem Bildschirm für Ihre Ressource im linken Navigationsmenü die Option Schlüssel und Endpunkt aus. Sie verwenden einen Ihrer Schlüssel und Ihren Endpunkt in den folgenden Schritten.

    Screenshot: Abschnitt „Schlüssel und Endpunkt“ für eine Ressource

Erstellen von Umgebungsvariablen

Ihre Anwendung muss authentifiziert werden, um API-Anforderungen senden zu können. In der Produktionsumgebung sollten Sie eine sichere Methode zum Speichern Ihrer Anmeldeinformationen sowie zum Zugriff darauf verwenden. In diesem Beispiel schreiben Sie Ihre Anmeldeinformationen in Umgebungsvariablen auf dem lokalen Computer, auf dem die Anwendung ausgeführt wird.

Tipp

Fügen Sie den Schlüssel nicht direkt in Ihren Code ein, und machen Sie ihn nicht öffentlich. Im Artikel zur Azure KI Services-Sicherheit finden Sie weitere Authentifizierungsoptionen wie zum Beispiel Azure Key Vault.

Um die Umgebungsvariable für Ihren Sprachressourcenschlüssel festzulegen, öffnen Sie ein Konsolenfenster und befolgen die Anweisungen für Ihr Betriebssystem und Ihre Entwicklungsumgebung.

  1. Zum Festlegen der Umgebungsvariablen LANGUAGE_KEY ersetzen Sie your-key durch einen der Schlüssel für Ihre Ressource.
  2. Zum Festlegen der Umgebungsvariablen LANGUAGE_ENDPOINT ersetzen Sie your-endpoint durch den Endpunkt für Ihre Ressource.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Hinweis

Wenn Sie nur in der aktuell ausgeführten Konsole auf die Umgebungsvariable zugreifen müssen, können Sie die Umgebungsvariable mit set anstelle von setx festlegen.

Nachdem Sie die Umgebungsvariable hinzugefügt haben, müssen Sie unter Umständen alle ausgeführten Programme neu starten, von denen die Umgebungsvariablen gelesen werden müssen, z. B. das Konsolenfenster. Wenn Sie beispielsweise Visual Studio als Editor verwenden, müssen Sie Visual Studio neu starten, bevor Sie das Beispiel ausführen.

Hinzufügen der Clientbibliothek

Erstellen Sie ein Maven-Projekt in Ihrer bevorzugten IDE oder Entwicklungsumgebung. Fügen Sie anschließend der Datei pom.xml Ihres Projekts die folgende Abhängigkeit hinzu. Die Implementierungssyntax für andere Buildtools ist online verfügbar.

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

Codebeispiel

Erstellen Sie eine Java-Datei mit dem Namen Example.java. Öffnen Sie die Datei, und kopieren Sie den folgenden Code. Führen Sie dann den Code aus.

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

public class Example {

    // This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
    private static String languageKey = System.getenv("LANGUAGE_KEY");
    private static String languageEndpoint = System.getenv("LANGUAGE_ENDPOINT");

    public static void main(String[] args) {
        TextAnalyticsClient client = authenticateClient(languageKey, languageEndpoint);
        recognizeEntitiesExample(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 recognizing entities in text
    static void recognizeEntitiesExample(TextAnalyticsClient client)
    {
        // The text that needs to be analyzed.
        String text = "I had a wonderful trip to Seattle last week.";
    
        for (CategorizedEntity entity : client.recognizeEntities(text)) {
            System.out.printf(
                "Recognized entity: %s, entity category: %s, entity sub-category: %s, score: %s, offset: %s, length: %s.%n",
                entity.getText(),
                entity.getCategory(),
                entity.getSubcategory(),
                entity.getConfidenceScore(),
                entity.getOffset(),
                entity.getLength());
        }
    }
}

Output

Recognized entity: trip, entity category: Event, entity sub-category: null, score: 0.74, offset: 18, length: 4.
Recognized entity: Seattle, entity category: Location, entity sub-category: GPE, score: 1.0, offset: 26, length: 7.
Recognized entity: last week, entity category: DateTime, entity sub-category: DateRange, score: 0.8, offset: 34, length: 9.

Referenzdokumentation | Weitere Beispiele | Paket (npm) | Quellcode der Bibliothek

Verwenden Sie diese Schnellstartanleitung, um eine Anwendung zur Erkennung benannter Entitäten (Named Entity Recognition, NER) mit der Clientbibliothek für Node.js zu erstellen. Im folgenden Beispiel erstellen Sie eine JavaScript-Anwendung, die erkannte Entitäten im Text identifizieren kann.

Voraussetzungen

Einrichten

Erstellen einer Azure-Ressource

Um das nachstehende Codebeispiel zu verwenden, müssen Sie eine Azure-Ressource bereitstellen. Diese Ressource enthält einen Schlüssel und Endpunkt, mit dem Sie die API-Aufrufe authentifizieren, die Sie an den Sprachdienst senden.

  1. Verwenden Sie den folgenden Link, um über das Azure-Portal eine Sprachressource zu erstellen. Sie müssen sich mit Ihrem Azure-Abonnement anmelden.

  2. Wählen Sie auf dem angezeigten Bildschirm Zusätzliche Funktionen auswählen die Option Fahren Sie fort mit dem Erstellen Ihrer Ressource aus.

    Screenshot: Optionen für zusätzliche Funktionen im Azure-Portal

  3. Geben Sie auf dem Bildschirm Sprache erstellen die folgenden Informationen an:

    Detail Beschreibung
    Subscription Das Abonnementkonto, mit dem Ihre Ressource verknüpft wird. Wählen Sie im Dropdownmenü Ihr Azure-Abonnement aus.
    Ressourcengruppe Eine Ressourcengruppe ist ein Container, der die von Ihnen erstellten Ressourcen speichert. Wählen Sie Neu erstellen aus, um eine neue Ressourcengruppe zu erstellen.
    Region Der Standort Ihrer Sprachressource Verschiedene Regionen können je nach physischem Standort Wartezeiten verursachen, haben aber keinen Einfluss auf die Laufzeitverfügbarkeit Ihrer Ressource. Wählen Sie für diesen Schnellstart entweder eine verfügbare Region in Ihrer Nähe oder USA, Osten aus.
    Name Der Name für Ihre Sprachressource. Dieser Name wird auch zum Erstellen einer Endpunkt-URL verwendet, die Ihre Anwendungen zum Senden von API-Anforderungen verwenden.
    Tarif Der Tarif für Ihre Sprachressource Sie können den Tarif Free F0 verwenden, um den Dienst zu testen, und später für die Produktion auf einen kostenpflichtigen Tarif upgraden.

    Screenshot: Details zur Ressourcenerstellung im Azure-Portal

  4. Vergewissern Sie sich, dass das Kontrollkästchen Hinweis zu verantwortungsvoller KI aktiviert ist.

  5. Wählen Sie am unteren Rand der Seite die Option Bewerten + erstellen aus.

  6. Stellen Sie auf dem angezeigten Bildschirm sicher, dass die Überprüfung erfolgreich war und dass Sie Ihre Informationen ordnungsgemäß eingegeben haben. Klicken Sie anschließend auf Erstellen.

Abrufen Ihres Schlüssels und Endpunkts

Als Nächstes benötigen Sie den Schlüssel und Endpunkt der Ressource, um Ihre Anwendung mit der API zu verbinden. Der Schlüssel und der Endpunkt werden später in der Schnellstartanleitung in den Code eingefügt.

  1. Klicken Sie nach erfolgreicher Bereitstellung der Sprachressource unter Nächste Schritte auf die Schaltfläche Zu Ressource wechseln.

    Screenshot: Nächste Schritte nach der Bereitstellung einer Ressource

  2. Wählen Sie auf dem Bildschirm für Ihre Ressource im linken Navigationsmenü die Option Schlüssel und Endpunkt aus. Sie verwenden einen Ihrer Schlüssel und Ihren Endpunkt in den folgenden Schritten.

    Screenshot: Abschnitt „Schlüssel und Endpunkt“ für eine Ressource

Erstellen von Umgebungsvariablen

Ihre Anwendung muss authentifiziert werden, um API-Anforderungen senden zu können. In der Produktionsumgebung sollten Sie eine sichere Methode zum Speichern Ihrer Anmeldeinformationen sowie zum Zugriff darauf verwenden. In diesem Beispiel schreiben Sie Ihre Anmeldeinformationen in Umgebungsvariablen auf dem lokalen Computer, auf dem die Anwendung ausgeführt wird.

Tipp

Fügen Sie den Schlüssel nicht direkt in Ihren Code ein, und machen Sie ihn nicht öffentlich. Im Artikel zur Azure KI Services-Sicherheit finden Sie weitere Authentifizierungsoptionen wie zum Beispiel Azure Key Vault.

Um die Umgebungsvariable für Ihren Sprachressourcenschlüssel festzulegen, öffnen Sie ein Konsolenfenster und befolgen die Anweisungen für Ihr Betriebssystem und Ihre Entwicklungsumgebung.

  1. Zum Festlegen der Umgebungsvariablen LANGUAGE_KEY ersetzen Sie your-key durch einen der Schlüssel für Ihre Ressource.
  2. Zum Festlegen der Umgebungsvariablen LANGUAGE_ENDPOINT ersetzen Sie your-endpoint durch den Endpunkt für Ihre Ressource.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Hinweis

Wenn Sie nur in der aktuell ausgeführten Konsole auf die Umgebungsvariable zugreifen müssen, können Sie die Umgebungsvariable mit set anstelle von setx festlegen.

Nachdem Sie die Umgebungsvariable hinzugefügt haben, müssen Sie unter Umständen alle ausgeführten Programme neu starten, von denen die Umgebungsvariablen gelesen werden müssen, z. B. das Konsolenfenster. Wenn Sie beispielsweise Visual Studio als Editor verwenden, müssen Sie Visual Studio neu starten, bevor Sie das Beispiel ausführen.

Erstellen einer neuen Node.js-Anwendung

Erstellen Sie in einem Konsolenfenster (etwa cmd, PowerShell oder Bash) ein neues Verzeichnis für Ihre App, und rufen Sie es auf.

mkdir myapp 

cd myapp

Führen Sie den Befehl npm init aus, um eine Knotenanwendung mit der Datei package.json zu erstellen.

npm init

Installieren der Clientbibliothek

Installieren des npm-Pakets:

npm install @azure/ai-language-text

Codebeispiel

Öffnen Sie die Datei, und kopieren Sie den folgenden Code. Führen Sie dann den Code aus.

"use strict";

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

// This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
const key = process.env.LANGUAGE_KEY;
const endpoint = process.env.LANGUAGE_ENDPOINT;

//an example document for entity recognition
const documents = [ "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, to develop and sell BASIC interpreters for the Altair 8800"];

//example of how to use the client library to recognize entities in a document.
async function main() {
    console.log("== NER sample ==");
  
    const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
  
    const results = await client.analyze("EntityRecognition", documents);
  
    for (const result of results) {
      console.log(`- Document ${result.id}`);
      if (!result.error) {
        console.log("\tRecognized Entities:");
        for (const entity of result.entities) {
          console.log(`\t- Entity ${entity.text} of type ${entity.category}`);
        }
      } else console.error("\tError:", result.error);
    }
  }

//call the main function
main().catch((err) => {
    console.error("The sample encountered an error:", err);
});

Output

Document ID: 0
        Name: Microsoft         Category: Organization  Subcategory: N/A
        Score: 0.29
        Name: Bill Gates        Category: Person        Subcategory: N/A
        Score: 0.78
        Name: Paul Allen        Category: Person        Subcategory: N/A
        Score: 0.82
        Name: April 4, 1975     Category: DateTime      Subcategory: Date
        Score: 0.8
        Name: 8800      Category: Quantity      Subcategory: Number
        Score: 0.8
Document ID: 1
        Name: 21        Category: Quantity      Subcategory: Number
        Score: 0.8
        Name: Seattle   Category: Location      Subcategory: GPE
        Score: 0.25

Referenzdokumentation | Weitere Beispiele | Paket (PyPi) | Quellcode der Bibliothek

Verwenden Sie diese Schnellstartanleitung, um eine Anwendung zur Erkennung benannter Entitäten (Named Entity Recognition, NER) mit der Clientbibliothek für Python zu erstellen. Im folgenden Beispiel erstellen Sie eine Python-Anwendung, die erkannte Entitäten im Text identifizieren kann.

Voraussetzungen

Einrichten

Installieren der Clientbibliothek

Nach der Installation von Python, können Sie die Clientbibliothek mit Folgendem installieren:

pip install azure-ai-textanalytics==5.2.0

Codebeispiel

Erstellen Sie eine neue Python-Datei, und kopieren Sie den folgenden Code. Führen Sie dann den Code aus.

# This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
language_key = os.environ.get('LANGUAGE_KEY')
language_endpoint = os.environ.get('LANGUAGE_ENDPOINT')

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(language_key)
    text_analytics_client = TextAnalyticsClient(
            endpoint=language_endpoint, 
            credential=ta_credential)
    return text_analytics_client

client = authenticate_client()

# Example function for recognizing entities from text
def entity_recognition_example(client):

    try:
        documents = ["I had a wonderful trip to Seattle last week."]
        result = client.recognize_entities(documents = documents)[0]

        print("Named Entities:\n")
        for entity in result.entities:
            print("\tText: \t", entity.text, "\tCategory: \t", entity.category, "\tSubCategory: \t", entity.subcategory,
                    "\n\tConfidence Score: \t", round(entity.confidence_score, 2), "\tLength: \t", entity.length, "\tOffset: \t", entity.offset, "\n")

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

Ausgabe

Named Entities:

    Text:    trip   Category:        Event  SubCategory:     None
    Confidence Score:        0.74   Length:          4      Offset:          18

    Text:    Seattle        Category:        Location       SubCategory:     GPE
    Confidence Score:        1.0    Length:          7      Offset:          26

    Text:    last week      Category:        DateTime       SubCategory:     DateRange
    Confidence Score:        0.8    Length:          9      Offset:          34

Referenzdokumentation

Verwenden Sie diese Schnellstartanleitung, um NER-Anforderungen (Named Entity Recognition, Erkennung benannter Entitäten) mithilfe der REST-API zu senden. Im folgenden Beispiel werden Sie cURL verwenden, um erkannte Entitäten im Text zu identifizieren.

Voraussetzungen

Einrichten

Erstellen einer Azure-Ressource

Um das nachstehende Codebeispiel zu verwenden, müssen Sie eine Azure-Ressource bereitstellen. Diese Ressource enthält einen Schlüssel und Endpunkt, mit dem Sie die API-Aufrufe authentifizieren, die Sie an den Sprachdienst senden.

  1. Verwenden Sie den folgenden Link, um über das Azure-Portal eine Sprachressource zu erstellen. Sie müssen sich mit Ihrem Azure-Abonnement anmelden.

  2. Wählen Sie auf dem angezeigten Bildschirm Zusätzliche Funktionen auswählen die Option Fahren Sie fort mit dem Erstellen Ihrer Ressource aus.

    Screenshot: Optionen für zusätzliche Funktionen im Azure-Portal

  3. Geben Sie auf dem Bildschirm Sprache erstellen die folgenden Informationen an:

    Detail Beschreibung
    Subscription Das Abonnementkonto, mit dem Ihre Ressource verknüpft wird. Wählen Sie im Dropdownmenü Ihr Azure-Abonnement aus.
    Ressourcengruppe Eine Ressourcengruppe ist ein Container, der die von Ihnen erstellten Ressourcen speichert. Wählen Sie Neu erstellen aus, um eine neue Ressourcengruppe zu erstellen.
    Region Der Standort Ihrer Sprachressource Verschiedene Regionen können je nach physischem Standort Wartezeiten verursachen, haben aber keinen Einfluss auf die Laufzeitverfügbarkeit Ihrer Ressource. Wählen Sie für diesen Schnellstart entweder eine verfügbare Region in Ihrer Nähe oder USA, Osten aus.
    Name Der Name für Ihre Sprachressource. Dieser Name wird auch zum Erstellen einer Endpunkt-URL verwendet, die Ihre Anwendungen zum Senden von API-Anforderungen verwenden.
    Tarif Der Tarif für Ihre Sprachressource Sie können den Tarif Free F0 verwenden, um den Dienst zu testen, und später für die Produktion auf einen kostenpflichtigen Tarif upgraden.

    Screenshot: Details zur Ressourcenerstellung im Azure-Portal

  4. Vergewissern Sie sich, dass das Kontrollkästchen Hinweis zu verantwortungsvoller KI aktiviert ist.

  5. Wählen Sie am unteren Rand der Seite die Option Bewerten + erstellen aus.

  6. Stellen Sie auf dem angezeigten Bildschirm sicher, dass die Überprüfung erfolgreich war und dass Sie Ihre Informationen ordnungsgemäß eingegeben haben. Klicken Sie anschließend auf Erstellen.

Abrufen Ihres Schlüssels und Endpunkts

Als Nächstes benötigen Sie den Schlüssel und Endpunkt der Ressource, um Ihre Anwendung mit der API zu verbinden. Der Schlüssel und der Endpunkt werden später in der Schnellstartanleitung in den Code eingefügt.

  1. Klicken Sie nach erfolgreicher Bereitstellung der Sprachressource unter Nächste Schritte auf die Schaltfläche Zu Ressource wechseln.

    Screenshot: Nächste Schritte nach der Bereitstellung einer Ressource

  2. Wählen Sie auf dem Bildschirm für Ihre Ressource im linken Navigationsmenü die Option Schlüssel und Endpunkt aus. Sie verwenden einen Ihrer Schlüssel und Ihren Endpunkt in den folgenden Schritten.

    Screenshot: Abschnitt „Schlüssel und Endpunkt“ für eine Ressource

Erstellen von Umgebungsvariablen

Ihre Anwendung muss authentifiziert werden, um API-Anforderungen senden zu können. In der Produktionsumgebung sollten Sie eine sichere Methode zum Speichern Ihrer Anmeldeinformationen sowie zum Zugriff darauf verwenden. In diesem Beispiel schreiben Sie Ihre Anmeldeinformationen in Umgebungsvariablen auf dem lokalen Computer, auf dem die Anwendung ausgeführt wird.

Tipp

Fügen Sie den Schlüssel nicht direkt in Ihren Code ein, und machen Sie ihn nicht öffentlich. Im Artikel zur Azure KI Services-Sicherheit finden Sie weitere Authentifizierungsoptionen wie zum Beispiel Azure Key Vault.

Um die Umgebungsvariable für Ihren Sprachressourcenschlüssel festzulegen, öffnen Sie ein Konsolenfenster und befolgen die Anweisungen für Ihr Betriebssystem und Ihre Entwicklungsumgebung.

  1. Zum Festlegen der Umgebungsvariablen LANGUAGE_KEY ersetzen Sie your-key durch einen der Schlüssel für Ihre Ressource.
  2. Zum Festlegen der Umgebungsvariablen LANGUAGE_ENDPOINT ersetzen Sie your-endpoint durch den Endpunkt für Ihre Ressource.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Hinweis

Wenn Sie nur in der aktuell ausgeführten Konsole auf die Umgebungsvariable zugreifen müssen, können Sie die Umgebungsvariable mit set anstelle von setx festlegen.

Nachdem Sie die Umgebungsvariable hinzugefügt haben, müssen Sie unter Umständen alle ausgeführten Programme neu starten, von denen die Umgebungsvariablen gelesen werden müssen, z. B. das Konsolenfenster. Wenn Sie beispielsweise Visual Studio als Editor verwenden, müssen Sie Visual Studio neu starten, bevor Sie das Beispiel ausführen.

Erstellen einer JSON-Datei mit dem Beispielanforderungstext

Erstellen Sie in einem Code-Editor eine neue Datei namens test_ner_payload.json, und kopieren Sie das folgende JSON-Beispiel. Diese Beispielanforderung wird im nächsten Schritt an die API gesendet.

{
    "kind": "EntityRecognition",
    "parameters": {
        "modelVersion": "latest"
    },
    "analysisInput":{
        "documents":[
            {
                "id":"1",
                "language": "en",
                "text": "I had a wonderful trip to Seattle last week."
            }
        ]
    }
}

Speichern Sie test_ner_payload.json irgendwo auf Ihrem Computer. Beispielsweise auf Ihrem Desktop.

Senden einer API-Anforderung zum Erkennen von benannten Entitäten

Verwenden Sie die folgenden Befehle, um die API-Anforderung mithilfe des von Ihnen genutzten Programms zu senden. Kopieren Sie den Befehl in Ihr Terminal, und führen Sie ihn aus.

parameter BESCHREIBUNG
-X POST <endpoint> Gibt den Endpunkt für den Zugriff auf die API an
-H Content-Type: application/json Der Inhaltstyp zum Senden von JSON-Daten
-H "Ocp-Apim-Subscription-Key:<key> Gibt den Schlüssel für den Zugriff auf die API an
-d <documents> Die JSON-Datei, die die zu sendenden Dokumente enthält

Ersetzen Sie C:\Users\<myaccount>\Desktop\test_ner_payload.json durch den Speicherort der im vorherigen Schritt erstellten JSON-Anforderungsdatei.

Eingabeaufforderung

curl -X POST "%LANGUAGE_ENDPOINT%/language/:analyze-text?api-version=2022-05-01" ^
-H "Content-Type: application/json" ^
-H "Ocp-Apim-Subscription-Key: %LANGUAGE_KEY%" ^
-d "@C:\Users\<myaccount>\Desktop\test_ner_payload.json"

PowerShell

curl.exe -X POST $env:LANGUAGE_ENDPOINT/language/:analyze-text?api-version=2022-05-01 `
-H "Content-Type: application/json" `
-H "Ocp-Apim-Subscription-Key: $env:LANGUAGE_KEY" `
-d "@C:\Users\<myaccount>\Desktop\test_ner_payload.json"

JSON-Antwort

Hinweis

{
	"kind": "EntityRecognitionResults",
	"results": {
		"documents": [{
			"id": "1",
			"entities": [{
				"text": "trip",
				"category": "Event",
				"offset": 18,
				"length": 4,
				"confidenceScore": 0.74
			}, {
				"text": "Seattle",
				"category": "Location",
				"subcategory": "GPE",
				"offset": 26,
				"length": 7,
				"confidenceScore": 1.0
			}, {
				"text": "last week",
				"category": "DateTime",
				"subcategory": "DateRange",
				"offset": 34,
				"length": 9,
				"confidenceScore": 0.8
			}],
			"warnings": []
		}],
		"errors": [],
		"modelVersion": "2021-06-01"
	}
}

Bereinigen von Ressourcen

Wenn Sie ein Azure KI Services-Abonnement bereinigen und entfernen möchten, können Sie die Ressource oder die Ressourcengruppe löschen. Wenn Sie die Ressourcengruppe löschen, werden auch alle anderen Ressourcen gelöscht, die ihr zugeordnet sind.

Nächste Schritte