Delen via

Quickstart: Persoonlijk identificeerbare informatie (PII) detecteren

  • Artikel

Notitie

In deze quickstart wordt alleen de PII-detectie in documenten behandeld. Zie PiI detecteren en redigeren in gesprekken voor meer informatie over het detecteren van PII in gesprekken.

Referentiedocumentatie Meer voorbeeldenpakket | (NuGet) | -bibliotheekbroncode |

Gebruik deze quickstart om een PII-detectietoepassing (Personally Identifiable Information) te maken met de clientbibliotheek voor .NET. In het volgende voorbeeld maakt u een C#-toepassing waarmee herkende gevoelige informatie in tekst kan worden geïdentificeerd.

Tip

U kunt Language Studio gebruiken om PII-detectie in documenten uit te proberen zonder dat u code hoeft te schrijven.

Vereisten

Instellen

Een Azure-resource maken

Als u het onderstaande codevoorbeeld wilt gebruiken, moet u een Azure-resource implementeren. Deze resource bevat een sleutel en eindpunt dat u gebruikt voor het verifiëren van de API-aanroepen die u naar de Taalservice verzendt.

  1. Gebruik de volgende koppeling om een taalresource te maken met behulp van Azure Portal. U moet zich aanmelden met uw Azure-abonnement.

  2. Selecteer doorgaan om uw resource te maken in het scherm Aanvullende functies selecteren dat wordt weergegeven.

    Een schermopname met extra functieopties in Azure Portal.

  3. Geef in het scherm Taal maken de volgende informatie op:

    Details Beschrijving
    Abonnement Het abonnementsaccount waaraan uw resource wordt gekoppeld. Selecteer uw Azure-abonnement in de vervolgkeuzelijst.
    Resourcegroep Een resourcegroep is een container waarin de resources die u maakt, worden opgeslagen. Selecteer Nieuwe maken om een nieuwe resourcegroep te maken.
    Regio De locatie van uw taalresource. Verschillende regio's kunnen latentie veroorzaken, afhankelijk van uw fysieke locatie, maar hebben geen invloed op de runtime-beschikbaarheid van uw resource. Voor deze quickstart selecteert u een beschikbare regio bij u in de buurt of kiest u VS - oost.
    Naam De naam voor uw taalresource. Deze naam wordt ook gebruikt om een eindpunt-URL te maken die uw toepassingen gebruiken om API-aanvragen te verzenden.
    Prijscategorie De prijscategorie voor uw taalresource. U kunt de gratis F0-laag gebruiken om de service uit te proberen en later een upgrade uit te voeren naar een betaalde laag voor productie.

    Een schermopname van details over het maken van resources in Azure Portal.

  4. Zorg ervoor dat het selectievakje Verantwoordelijke AI-kennisgeving is ingeschakeld.

  5. Selecteer Controleren en maken onderaan de pagina.

  6. Controleer in het scherm dat wordt weergegeven of de validatie is geslaagd en of u de gegevens correct hebt ingevoerd. Selecteer vervolgens Maken.

Uw sleutel en eindpunt ophalen

Vervolgens hebt u de sleutel en het eindpunt van de resource nodig om uw toepassing te verbinden met de API. Verderop in de quickstart plakt u uw sleutel en eindpunt in de code.

  1. Nadat de taalresource is geïmplementeerd, klikt u onder Volgende stappen op de knop Naar de resource gaan.

    Een schermopname van de volgende stappen nadat een resource is geïmplementeerd.

  2. Selecteer sleutels en eindpunt in het linkernavigatiemenu op het scherm voor uw resource. U gebruikt een van uw sleutels en uw eindpunt in de onderstaande stappen.

    Een schermopname van de sectie sleutels en eindpunten voor een resource.

Omgevingsvariabelen maken

Uw toepassing moet worden geverifieerd om API-aanvragen te verzenden. Gebruik voor productie een veilige manier om uw referenties op te slaan en te openen. In dit voorbeeld schrijft u uw referenties naar omgevingsvariabelen op de lokale computer waarop de toepassing wordt uitgevoerd.

Als u de omgevingsvariabele voor uw taalresourcesleutel wilt instellen, opent u een consolevenster en volgt u de instructies voor uw besturingssysteem en ontwikkelomgeving.

  • Als u de LANGUAGE_KEY omgevingsvariabele wilt instellen, vervangt u deze door your-key een van de sleutels voor uw resource.
  • Als u de LANGUAGE_ENDPOINT omgevingsvariabele wilt instellen, vervangt your-endpoint u het eindpunt voor uw resource.

Belangrijk

Als u een API-sleutel gebruikt, slaat u deze veilig op ergens anders op, zoals in Azure Key Vault. Neem de API-sleutel niet rechtstreeks in uw code op en plaats deze nooit openbaar.

Zie Aanvragen verifiëren bij Azure AI-services voor meer informatie over beveiliging van AI-services.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Notitie

Als u alleen toegang nodig hebt tot de omgevingsvariabelen in de huidige actieve console, kunt u de omgevingsvariabele instellen in set plaats van setx.

Nadat u de omgevingsvariabelen hebt toegevoegd, moet u mogelijk alle actieve programma's opnieuw opstarten die de omgevingsvariabelen moeten lezen, inclusief het consolevenster. Als u bijvoorbeeld Visual Studio als editor gebruikt, start u Visual Studio opnieuw voordat u het voorbeeld uitvoert.

Een nieuwe .NET Core-app maken

Maak een nieuwe console-app in .NET Core met behulp van de Visual Studio IDE. Hiermee maakt u een project 'Hallo wereld' met één C#-bronbestand: 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 en voer de code uit.

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 detecting sensitive information (PII) from text 
        static void RecognizePIIExample(TextAnalyticsClient client)
        {
            string document = "Call our office at 312-555-1234, or send an email to support@contoso.com.";
        
            PiiEntityCollection entities = client.RecognizePiiEntities(document).Value;
        
            Console.WriteLine($"Redacted Text: {entities.RedactedText}");
            if (entities.Count > 0)
            {
                Console.WriteLine($"Recognized {entities.Count} PII entit{(entities.Count > 1 ? "ies" : "y")}:");
                foreach (PiiEntity entity in entities)
                {
                    Console.WriteLine($"Text: {entity.Text}, Category: {entity.Category}, SubCategory: {entity.SubCategory}, Confidence score: {entity.ConfidenceScore}");
                }
            }
            else
            {
                Console.WriteLine("No entities were found.");
            }
        }

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

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

    }
}

Uitvoer

Redacted Text: Call our office at ************, or send an email to *******************.
Recognized 2 PII entities:
Text: 312-555-1234, Category: PhoneNumber, SubCategory: , Confidence score: 0.8
Text: support@contoso.com, Category: Email, SubCategory: , Confidence score: 0.8

Referentiedocumentatie | Meer voorbeelden | pakket (Maven) | Bibliotheek broncode

Gebruik deze quickstart om een PII-detectietoepassing (Personally Identifiable Information) te maken met de clientbibliotheek voor Java. In het volgende voorbeeld maakt u een Java-toepassing waarmee herkende gevoelige informatie in tekst kan worden geïdentificeerd.

Tip

U kunt Language Studio gebruiken om PII-detectie in documenten uit te proberen zonder dat u code hoeft te schrijven.

Vereisten

Instellen

Een Azure-resource maken

Als u het onderstaande codevoorbeeld wilt gebruiken, moet u een Azure-resource implementeren. Deze resource bevat een sleutel en eindpunt dat u gebruikt voor het verifiëren van de API-aanroepen die u naar de Taalservice verzendt.

  1. Gebruik de volgende koppeling om een taalresource te maken met behulp van Azure Portal. U moet zich aanmelden met uw Azure-abonnement.

  2. Selecteer doorgaan om uw resource te maken in het scherm Aanvullende functies selecteren dat wordt weergegeven.

    Een schermopname met extra functieopties in Azure Portal.

  3. Geef in het scherm Taal maken de volgende informatie op:

    Details Beschrijving
    Abonnement Het abonnementsaccount waaraan uw resource wordt gekoppeld. Selecteer uw Azure-abonnement in de vervolgkeuzelijst.
    Resourcegroep Een resourcegroep is een container waarin de resources die u maakt, worden opgeslagen. Selecteer Nieuwe maken om een nieuwe resourcegroep te maken.
    Regio De locatie van uw taalresource. Verschillende regio's kunnen latentie veroorzaken, afhankelijk van uw fysieke locatie, maar hebben geen invloed op de runtime-beschikbaarheid van uw resource. Voor deze quickstart selecteert u een beschikbare regio bij u in de buurt of kiest u VS - oost.
    Naam De naam voor uw taalresource. Deze naam wordt ook gebruikt om een eindpunt-URL te maken die uw toepassingen gebruiken om API-aanvragen te verzenden.
    Prijscategorie De prijscategorie voor uw taalresource. U kunt de gratis F0-laag gebruiken om de service uit te proberen en later een upgrade uit te voeren naar een betaalde laag voor productie.

    Een schermopname van details over het maken van resources in Azure Portal.

  4. Zorg ervoor dat het selectievakje Verantwoordelijke AI-kennisgeving is ingeschakeld.

  5. Selecteer Controleren en maken onderaan de pagina.

  6. Controleer in het scherm dat wordt weergegeven of de validatie is geslaagd en of u de gegevens correct hebt ingevoerd. Selecteer vervolgens Maken.

Uw sleutel en eindpunt ophalen

Vervolgens hebt u de sleutel en het eindpunt van de resource nodig om uw toepassing te verbinden met de API. Verderop in de quickstart plakt u uw sleutel en eindpunt in de code.

  1. Nadat de taalresource is geïmplementeerd, klikt u onder Volgende stappen op de knop Naar de resource gaan.

    Een schermopname van de volgende stappen nadat een resource is geïmplementeerd.

  2. Selecteer sleutels en eindpunt in het linkernavigatiemenu op het scherm voor uw resource. U gebruikt een van uw sleutels en uw eindpunt in de onderstaande stappen.

    Een schermopname van de sectie sleutels en eindpunten voor een resource.

Omgevingsvariabelen maken

Uw toepassing moet worden geverifieerd om API-aanvragen te verzenden. Gebruik voor productie een veilige manier om uw referenties op te slaan en te openen. In dit voorbeeld schrijft u uw referenties naar omgevingsvariabelen op de lokale computer waarop de toepassing wordt uitgevoerd.

Als u de omgevingsvariabele voor uw taalresourcesleutel wilt instellen, opent u een consolevenster en volgt u de instructies voor uw besturingssysteem en ontwikkelomgeving.

  • Als u de LANGUAGE_KEY omgevingsvariabele wilt instellen, vervangt u deze door your-key een van de sleutels voor uw resource.
  • Als u de LANGUAGE_ENDPOINT omgevingsvariabele wilt instellen, vervangt your-endpoint u het eindpunt voor uw resource.

Belangrijk

Als u een API-sleutel gebruikt, slaat u deze veilig op ergens anders op, zoals in Azure Key Vault. Neem de API-sleutel niet rechtstreeks in uw code op en plaats deze nooit openbaar.

Zie Aanvragen verifiëren bij Azure AI-services voor meer informatie over beveiliging van AI-services.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Notitie

Als u alleen toegang nodig hebt tot de omgevingsvariabelen in de huidige actieve console, kunt u de omgevingsvariabele instellen in set plaats van setx.

Nadat u de omgevingsvariabelen hebt toegevoegd, moet u mogelijk alle actieve programma's opnieuw opstarten die de omgevingsvariabelen moeten lezen, inclusief het consolevenster. Als u bijvoorbeeld Visual Studio als editor gebruikt, start u Visual Studio opnieuw voordat u het voorbeeld uitvoert.

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. Voer de code vervolgens uit.

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);
        recognizePiiEntitiesExample(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 detecting sensitive information (PII) from text 
    static void recognizePiiEntitiesExample(TextAnalyticsClient client)
    {
        // The text that need be analyzed.
        String document = "My SSN is 859-98-0987";
        PiiEntityCollection piiEntityCollection = client.recognizePiiEntities(document);
        System.out.printf("Redacted Text: %s%n", piiEntityCollection.getRedactedText());
        piiEntityCollection.forEach(entity -> System.out.printf(
            "Recognized Personally Identifiable Information entity: %s, entity category: %s, entity subcategory: %s,"
                + " confidence score: %f.%n",
            entity.getText(), entity.getCategory(), entity.getSubcategory(), entity.getConfidenceScore()));
    }
}

Uitvoer

Redacted Text: My SSN is ***********
Recognized Personally Identifiable Information entity: 859-98-0987, entity category: USSocialSecurityNumber, entity subcategory: null, confidence score: 0.650000.

Referentiedocumentatie | Meer voorbeelden | pakket (npm) | bibliotheek broncode

Gebruik deze quickstart om een PII-detectietoepassing (Personally Identifiable Information) te maken met de clientbibliotheek voor Node.js. In het volgende voorbeeld maakt u een JavaScript-toepassing waarmee herkende gevoelige informatie in tekst kan worden geïdentificeerd.

Vereisten

Instellen

Een Azure-resource maken

Als u het onderstaande codevoorbeeld wilt gebruiken, moet u een Azure-resource implementeren. Deze resource bevat een sleutel en eindpunt dat u gebruikt voor het verifiëren van de API-aanroepen die u naar de Taalservice verzendt.

  1. Gebruik de volgende koppeling om een taalresource te maken met behulp van Azure Portal. U moet zich aanmelden met uw Azure-abonnement.

  2. Selecteer doorgaan om uw resource te maken in het scherm Aanvullende functies selecteren dat wordt weergegeven.

    Een schermopname met extra functieopties in Azure Portal.

  3. Geef in het scherm Taal maken de volgende informatie op:

    Details Beschrijving
    Abonnement Het abonnementsaccount waaraan uw resource wordt gekoppeld. Selecteer uw Azure-abonnement in de vervolgkeuzelijst.
    Resourcegroep Een resourcegroep is een container waarin de resources die u maakt, worden opgeslagen. Selecteer Nieuwe maken om een nieuwe resourcegroep te maken.
    Regio De locatie van uw taalresource. Verschillende regio's kunnen latentie veroorzaken, afhankelijk van uw fysieke locatie, maar hebben geen invloed op de runtime-beschikbaarheid van uw resource. Voor deze quickstart selecteert u een beschikbare regio bij u in de buurt of kiest u VS - oost.
    Naam De naam voor uw taalresource. Deze naam wordt ook gebruikt om een eindpunt-URL te maken die uw toepassingen gebruiken om API-aanvragen te verzenden.
    Prijscategorie De prijscategorie voor uw taalresource. U kunt de gratis F0-laag gebruiken om de service uit te proberen en later een upgrade uit te voeren naar een betaalde laag voor productie.

    Een schermopname van details over het maken van resources in Azure Portal.

  4. Zorg ervoor dat het selectievakje Verantwoordelijke AI-kennisgeving is ingeschakeld.

  5. Selecteer Controleren en maken onderaan de pagina.

  6. Controleer in het scherm dat wordt weergegeven of de validatie is geslaagd en of u de gegevens correct hebt ingevoerd. Selecteer vervolgens Maken.

Uw sleutel en eindpunt ophalen

Vervolgens hebt u de sleutel en het eindpunt van de resource nodig om uw toepassing te verbinden met de API. Verderop in de quickstart plakt u uw sleutel en eindpunt in de code.

  1. Nadat de taalresource is geïmplementeerd, klikt u onder Volgende stappen op de knop Naar de resource gaan.

    Een schermopname van de volgende stappen nadat een resource is geïmplementeerd.

  2. Selecteer sleutels en eindpunt in het linkernavigatiemenu op het scherm voor uw resource. U gebruikt een van uw sleutels en uw eindpunt in de onderstaande stappen.

    Een schermopname van de sectie sleutels en eindpunten voor een resource.

Omgevingsvariabelen maken

Uw toepassing moet worden geverifieerd om API-aanvragen te verzenden. Gebruik voor productie een veilige manier om uw referenties op te slaan en te openen. In dit voorbeeld schrijft u uw referenties naar omgevingsvariabelen op de lokale computer waarop de toepassing wordt uitgevoerd.

Als u de omgevingsvariabele voor uw taalresourcesleutel wilt instellen, opent u een consolevenster en volgt u de instructies voor uw besturingssysteem en ontwikkelomgeving.

  • Als u de LANGUAGE_KEY omgevingsvariabele wilt instellen, vervangt u deze door your-key een van de sleutels voor uw resource.
  • Als u de LANGUAGE_ENDPOINT omgevingsvariabele wilt instellen, vervangt your-endpoint u het eindpunt voor uw resource.

Belangrijk

Als u een API-sleutel gebruikt, slaat u deze veilig op ergens anders op, zoals in Azure Key Vault. Neem de API-sleutel niet rechtstreeks in uw code op en plaats deze nooit openbaar.

Zie Aanvragen verifiëren bij Azure AI-services voor meer informatie over beveiliging van AI-services.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Notitie

Als u alleen toegang nodig hebt tot de omgevingsvariabelen in de huidige actieve console, kunt u de omgevingsvariabele instellen in set plaats van setx.

Nadat u de omgevingsvariabelen hebt toegevoegd, moet u mogelijk alle actieve programma's opnieuw opstarten die de omgevingsvariabelen moeten lezen, inclusief het consolevenster. Als u bijvoorbeeld Visual Studio als editor gebruikt, start u Visual Studio opnieuw voordat u het voorbeeld uitvoert.

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-text-analytics

Voorbeeld van code

Open het bestand en kopieer de onderstaande code. Voer de code vervolgens uit.

"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 pii recognition
const documents = [ "The employee's phone number is (555) 555-5555." ];

async function main() {
    console.log(`PII recognition sample`);
  
    const client = new TextAnalyticsClient(endpoint, new AzureKeyCredential(key));
  
    const documents = ["My phone number is 555-555-5555"];
  
    const [result] = await client.analyze("PiiEntityRecognition", documents, "en");
  
    if (!result.error) {
      console.log(`Redacted text: "${result.redactedText}"`);
      console.log("Pii Entities: ");
      for (const entity of result.entities) {
        console.log(`\t- "${entity.text}" of type ${entity.category}`);
      }
    }
}

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

Uitvoer

PII recognition sample
Redacted text: "My phone number is ************"
Pii Entities:
        - "555-555-5555" of type PhoneNumber

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

Gebruik deze quickstart om een PII-detectietoepassing (Personally Identifiable Information) te maken met de clientbibliotheek voor Python. In het volgende voorbeeld maakt u een Python-toepassing waarmee herkende gevoelige informatie in tekst kan worden geïdentificeerd.

Vereisten

Instellen

Een Azure-resource maken

Als u het onderstaande codevoorbeeld wilt gebruiken, moet u een Azure-resource implementeren. Deze resource bevat een sleutel en eindpunt dat u gebruikt voor het verifiëren van de API-aanroepen die u naar de Taalservice verzendt.

  1. Gebruik de volgende koppeling om een taalresource te maken met behulp van Azure Portal. U moet zich aanmelden met uw Azure-abonnement.

  2. Selecteer doorgaan om uw resource te maken in het scherm Aanvullende functies selecteren dat wordt weergegeven.

    Een schermopname met extra functieopties in Azure Portal.

  3. Geef in het scherm Taal maken de volgende informatie op:

    Details Beschrijving
    Abonnement Het abonnementsaccount waaraan uw resource wordt gekoppeld. Selecteer uw Azure-abonnement in de vervolgkeuzelijst.
    Resourcegroep Een resourcegroep is een container waarin de resources die u maakt, worden opgeslagen. Selecteer Nieuwe maken om een nieuwe resourcegroep te maken.
    Regio De locatie van uw taalresource. Verschillende regio's kunnen latentie veroorzaken, afhankelijk van uw fysieke locatie, maar hebben geen invloed op de runtime-beschikbaarheid van uw resource. Voor deze quickstart selecteert u een beschikbare regio bij u in de buurt of kiest u VS - oost.
    Naam De naam voor uw taalresource. Deze naam wordt ook gebruikt om een eindpunt-URL te maken die uw toepassingen gebruiken om API-aanvragen te verzenden.
    Prijscategorie De prijscategorie voor uw taalresource. U kunt de gratis F0-laag gebruiken om de service uit te proberen en later een upgrade uit te voeren naar een betaalde laag voor productie.

    Een schermopname van details over het maken van resources in Azure Portal.

  4. Zorg ervoor dat het selectievakje Verantwoordelijke AI-kennisgeving is ingeschakeld.

  5. Selecteer Controleren en maken onderaan de pagina.

  6. Controleer in het scherm dat wordt weergegeven of de validatie is geslaagd en of u de gegevens correct hebt ingevoerd. Selecteer vervolgens Maken.

Uw sleutel en eindpunt ophalen

Vervolgens hebt u de sleutel en het eindpunt van de resource nodig om uw toepassing te verbinden met de API. Verderop in de quickstart plakt u uw sleutel en eindpunt in de code.

  1. Nadat de taalresource is geïmplementeerd, klikt u onder Volgende stappen op de knop Naar de resource gaan.

    Een schermopname van de volgende stappen nadat een resource is geïmplementeerd.

  2. Selecteer sleutels en eindpunt in het linkernavigatiemenu op het scherm voor uw resource. U gebruikt een van uw sleutels en uw eindpunt in de onderstaande stappen.

    Een schermopname van de sectie sleutels en eindpunten voor een resource.

Omgevingsvariabelen maken

Uw toepassing moet worden geverifieerd om API-aanvragen te verzenden. Gebruik voor productie een veilige manier om uw referenties op te slaan en te openen. In dit voorbeeld schrijft u uw referenties naar omgevingsvariabelen op de lokale computer waarop de toepassing wordt uitgevoerd.

Als u de omgevingsvariabele voor uw taalresourcesleutel wilt instellen, opent u een consolevenster en volgt u de instructies voor uw besturingssysteem en ontwikkelomgeving.

  • Als u de LANGUAGE_KEY omgevingsvariabele wilt instellen, vervangt u deze door your-key een van de sleutels voor uw resource.
  • Als u de LANGUAGE_ENDPOINT omgevingsvariabele wilt instellen, vervangt your-endpoint u het eindpunt voor uw resource.

Belangrijk

Als u een API-sleutel gebruikt, slaat u deze veilig op ergens anders op, zoals in Azure Key Vault. Neem de API-sleutel niet rechtstreeks in uw code op en plaats deze nooit openbaar.

Zie Aanvragen verifiëren bij Azure AI-services voor meer informatie over beveiliging van AI-services.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Notitie

Als u alleen toegang nodig hebt tot de omgevingsvariabelen in de huidige actieve console, kunt u de omgevingsvariabele instellen in set plaats van setx.

Nadat u de omgevingsvariabelen hebt toegevoegd, moet u mogelijk alle actieve programma's opnieuw opstarten die de omgevingsvariabelen moeten lezen, inclusief het consolevenster. Als u bijvoorbeeld Visual Studio als editor gebruikt, start u Visual Studio opnieuw voordat u het voorbeeld uitvoert.

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. Voer de code vervolgens uit.

# 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 method for detecting sensitive information (PII) from text 
def pii_recognition_example(client):
    documents = [
        "The employee's SSN is 859-98-0987.",
        "The employee's phone number is 555-555-5555."
    ]
    response = client.recognize_pii_entities(documents, language="en")
    result = [doc for doc in response if not doc.is_error]
    for doc in result:
        print("Redacted Text: {}".format(doc.redacted_text))
        for entity in doc.entities:
            print("Entity: {}".format(entity.text))
            print("\tCategory: {}".format(entity.category))
            print("\tConfidence Score: {}".format(entity.confidence_score))
            print("\tOffset: {}".format(entity.offset))
            print("\tLength: {}".format(entity.length))
pii_recognition_example(client)

Uitvoer

Redacted Text: The ********'s SSN is ***********.
Entity: employee
        Category: PersonType
        Confidence Score: 0.97
        Offset: 4
        Length: 8
Entity: 859-98-0987
        Category: USSocialSecurityNumber
        Confidence Score: 0.65
        Offset: 22
        Length: 11
Redacted Text: The ********'s phone number is ************.
Entity: employee
        Category: PersonType
        Confidence Score: 0.96
        Offset: 4
        Length: 8
Entity: 555-555-5555
        Category: PhoneNumber
        Confidence Score: 0.8
        Offset: 31
        Length: 12

Referentiedocumentatie

Gebruik deze quickstart om PII-detectieaanvragen (Personally Identifiable Information) te verzenden met behulp van de REST API. In het volgende voorbeeld gebruikt u cURL om herkende gevoelige informatie in tekst te identificeren.

Vereisten

Instellen

Een Azure-resource maken

Als u het onderstaande codevoorbeeld wilt gebruiken, moet u een Azure-resource implementeren. Deze resource bevat een sleutel en eindpunt dat u gebruikt voor het verifiëren van de API-aanroepen die u naar de Taalservice verzendt.

  1. Gebruik de volgende koppeling om een taalresource te maken met behulp van Azure Portal. U moet zich aanmelden met uw Azure-abonnement.

  2. Selecteer doorgaan om uw resource te maken in het scherm Aanvullende functies selecteren dat wordt weergegeven.

    Een schermopname met extra functieopties in Azure Portal.

  3. Geef in het scherm Taal maken de volgende informatie op:

    Details Beschrijving
    Abonnement Het abonnementsaccount waaraan uw resource wordt gekoppeld. Selecteer uw Azure-abonnement in de vervolgkeuzelijst.
    Resourcegroep Een resourcegroep is een container waarin de resources die u maakt, worden opgeslagen. Selecteer Nieuwe maken om een nieuwe resourcegroep te maken.
    Regio De locatie van uw taalresource. Verschillende regio's kunnen latentie veroorzaken, afhankelijk van uw fysieke locatie, maar hebben geen invloed op de runtime-beschikbaarheid van uw resource. Voor deze quickstart selecteert u een beschikbare regio bij u in de buurt of kiest u VS - oost.
    Naam De naam voor uw taalresource. Deze naam wordt ook gebruikt om een eindpunt-URL te maken die uw toepassingen gebruiken om API-aanvragen te verzenden.
    Prijscategorie De prijscategorie voor uw taalresource. U kunt de gratis F0-laag gebruiken om de service uit te proberen en later een upgrade uit te voeren naar een betaalde laag voor productie.

    Een schermopname van details over het maken van resources in Azure Portal.

  4. Zorg ervoor dat het selectievakje Verantwoordelijke AI-kennisgeving is ingeschakeld.

  5. Selecteer Controleren en maken onderaan de pagina.

  6. Controleer in het scherm dat wordt weergegeven of de validatie is geslaagd en of u de gegevens correct hebt ingevoerd. Selecteer vervolgens Maken.

Uw sleutel en eindpunt ophalen

Vervolgens hebt u de sleutel en het eindpunt van de resource nodig om uw toepassing te verbinden met de API. Verderop in de quickstart plakt u uw sleutel en eindpunt in de code.

  1. Nadat de taalresource is geïmplementeerd, klikt u onder Volgende stappen op de knop Naar de resource gaan.

    Een schermopname van de volgende stappen nadat een resource is geïmplementeerd.

  2. Selecteer sleutels en eindpunt in het linkernavigatiemenu op het scherm voor uw resource. U gebruikt een van uw sleutels en uw eindpunt in de onderstaande stappen.

    Een schermopname van de sectie sleutels en eindpunten voor een resource.

Omgevingsvariabelen maken

Uw toepassing moet worden geverifieerd om API-aanvragen te verzenden. Gebruik voor productie een veilige manier om uw referenties op te slaan en te openen. In dit voorbeeld schrijft u uw referenties naar omgevingsvariabelen op de lokale computer waarop de toepassing wordt uitgevoerd.

Als u de omgevingsvariabele voor uw taalresourcesleutel wilt instellen, opent u een consolevenster en volgt u de instructies voor uw besturingssysteem en ontwikkelomgeving.

  • Als u de LANGUAGE_KEY omgevingsvariabele wilt instellen, vervangt u deze door your-key een van de sleutels voor uw resource.
  • Als u de LANGUAGE_ENDPOINT omgevingsvariabele wilt instellen, vervangt your-endpoint u het eindpunt voor uw resource.

Belangrijk

Als u een API-sleutel gebruikt, slaat u deze veilig op ergens anders op, zoals in Azure Key Vault. Neem de API-sleutel niet rechtstreeks in uw code op en plaats deze nooit openbaar.

Zie Aanvragen verifiëren bij Azure AI-services voor meer informatie over beveiliging van AI-services.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Notitie

Als u alleen toegang nodig hebt tot de omgevingsvariabelen in de huidige actieve console, kunt u de omgevingsvariabele instellen in set plaats van setx.

Nadat u de omgevingsvariabelen hebt toegevoegd, moet u mogelijk alle actieve programma's opnieuw opstarten die de omgevingsvariabelen moeten lezen, inclusief het consolevenster. Als u bijvoorbeeld Visual Studio als editor gebruikt, start u Visual Studio opnieuw voordat u het voorbeeld uitvoert.

Een JSON-bestand maken met de voorbeeldtekst van de aanvraag

Maak in een code-editor een nieuw bestand met de naam test_pii_payload.json en kopieer het volgende JSON-voorbeeld. Deze voorbeeldaanvraag wordt in de volgende stap naar de API verzonden.

{
    "kind": "PiiEntityRecognition",
    "parameters": {
        "modelVersion": "latest"
    },
    "analysisInput":{
        "documents":[
            {
                "id":"1",
                "language": "en",
                "text": "Call our office at 312-555-1234, or send an email to support@contoso.com"
            }
        ]
    }
}
'

Sla test_pii_payload.json ergens op uw computer op. Bijvoorbeeld uw bureaublad.

Een API-aanvraag voor persoonlijke identificatiegegevens (PII) verzenden

Gebruik de volgende opdrachten om de API-aanvraag te verzenden met behulp van het programma dat u gebruikt. Kopieer de opdracht naar uw terminal en voer deze uit.

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.

Vervang C:\Users\<myaccount>\Desktop\test_pii_payload.json door de locatie van het voorbeeld-JSON-aanvraagbestand dat u in de vorige stap hebt gemaakt.

Opdrachtprompt

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_pii_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_pii_payload.json"

JSON-antwoord

{
	"kind": "PiiEntityRecognitionResults",
	"results": {
		"documents": [{
			"redactedText": "Call our office at ************, or send an email to *******************",
			"id": "1",
			"entities": [{
				"text": "312-555-1234",
				"category": "PhoneNumber",
				"offset": 19,
				"length": 12,
				"confidenceScore": 0.8
			}, {
				"text": "support@contoso.com",
				"category": "Email",
				"offset": 53,
				"length": 19,
				"confidenceScore": 0.8
			}],
			"warnings": []
		}],
		"errors": [],
		"modelVersion": "2021-01-15"
	}
}

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