Share via

Rychlý start: Zjištění identifikovatelných osobních údajů (PII)

  • Článek

Poznámka:

Tento rychlý start se zabývá pouze detekcí PII v dokumentech. Další informace o detekci PII v konverzacích najdete v tématu Zjišťování a redact PII v konverzacích.

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

Pomocí tohoto rychlého startu vytvoříte aplikaci pro detekci osobních údajů (PII) s klientskou knihovnou pro .NET. V následujícím příkladu vytvoříte aplikaci jazyka C#, která dokáže identifikovat rozpoznané citlivé informace v textu.

Tip

Language Studio můžete použít k vyzkoušení detekce PII v dokumentech, aniž byste museli psát kód.

Požadavky

Nastavení

Vytvoření prostředku Azure

Pokud chcete použít níže uvedený vzorový kód, budete muset nasadit prostředek Azure. Tento prostředek bude obsahovat klíč a koncový bod, které použijete k ověření volání rozhraní API, která odesíláte do služby Language.

  1. Pomocí následujícího odkazu vytvořte prostředek jazyka pomocí webu Azure Portal. Budete se muset přihlásit pomocí svého předplatného Azure.

  2. Na obrazovce Vybrat další funkce, která se zobrazí, vyberte Pokračovat a vytvořte prostředek.

    Snímek obrazovky s dalšími možnostmi funkcí na webu Azure Portal

  3. Na obrazovce Vytvořit jazyk zadejte následující informace:

    Detail Popis
    Předplatné Účet předplatného, ke kterému bude váš prostředek přidružený. V rozevírací nabídce vyberte své předplatné Azure.
    Skupina prostředků Skupina prostředků je kontejner, který ukládá prostředky, které vytvoříte. Vyberte Vytvořit novou a vytvořte novou skupinu prostředků.
    Oblast Umístění vašeho prostředku Jazyk. Různé oblasti můžou v závislosti na fyzickém umístění zavádět latenci, ale nemají žádný vliv na dostupnost modulu runtime vašeho prostředku. Pro účely tohoto rychlého startu vyberte dostupnou oblast blízko vás nebo zvolte USA – východ.
    Název Název vašeho prostředku jazyka Tento název se také použije k vytvoření adresy URL koncového bodu, kterou budou vaše aplikace používat k odesílání požadavků rozhraní API.
    Cenová úroveň Cenová úroveň vašeho prostředku Jazyk. Pomocí úrovně Free F0 můžete službu vyzkoušet a upgradovat na placenou úroveň pro produkční prostředí.

    Snímek obrazovky znázorňující podrobnosti o vytvoření prostředku na webu Azure Portal

  4. Ujistěte se, že je zaškrtnuté políčko Zodpovědné oznámení O umělé inteligenci.

  5. V dolní části stránky vyberte Zkontrolovat a vytvořit .

  6. Na obrazovce, která se zobrazí, se ujistěte, že ověření proběhlo a že jste správně zadali informace. Pak vyberte Vytvořit.

Získání klíče a koncového bodu

Dále budete potřebovat klíč a koncový bod z prostředku pro připojení aplikace k rozhraní API. Klíč a koncový bod vložíte do kódu později v rychlém startu.

  1. Po úspěšném nasazení prostředku jazyka klikněte v části Další kroky na tlačítko Přejít k prostředku.

    Snímek obrazovky znázorňující další kroky po nasazení prostředku

  2. Na obrazovce vašeho prostředku vyberte klíče a koncový bod v levé navigační nabídce. V následujících krocích použijete jeden ze svých klíčů a koncový bod.

    Snímek obrazovky znázorňující oddíl klíčů a koncového bodu prostředku

Vytvoření proměnných prostředí

Aby vaše aplikace odesílala požadavky rozhraní API, musí být ověřená. V produkčním prostředí použijte bezpečný způsob ukládání a přístupu k vašim přihlašovacím údajům. V tomto příkladu zapíšete přihlašovací údaje do proměnných prostředí na místním počítači, na kterém běží aplikace.

Tip

Nezahrňte klíč přímo do kódu a nikdy ho nesdělujte veřejně. Další možnosti ověřování, jako je Azure Key Vault, najdete v článku zabezpečení služeb Azure AI.

Pokud chcete nastavit proměnnou prostředí pro klíč prostředku jazyka, otevřete okno konzoly a postupujte podle pokynů pro operační systém a vývojové prostředí.

  1. Pokud chcete nastavit proměnnou LANGUAGE_KEY prostředí, nahraďte your-key jedním z klíčů pro váš prostředek.
  2. Pokud chcete nastavit proměnnou LANGUAGE_ENDPOINT prostředí, nahraďte your-endpoint koncovým bodem vašeho prostředku.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Poznámka:

Pokud potřebujete přístup pouze k proměnným prostředí v aktuální spuštěné konzole, můžete nastavit proměnnou set prostředí namísto setx.

Po přidání proměnných prostředí možná budete muset restartovat všechny spuštěné programy, které budou muset číst proměnné prostředí, včetně okna konzoly. Pokud například jako editor používáte Sadu Visual Studio, restartujte sadu Visual Studio před spuštěním příkladu.

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. Tím se vytvoří 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

Zkopírujte následující kód do souboru program.cs a spusťte kód.

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

    }
}

Výstup

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

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

V tomto rychlém startu můžete vytvořit aplikaci pro detekci osobních údajů (PII) s klientskou knihovnou pro Javu. V následujícím příkladu vytvoříte aplikaci v Javě, která dokáže identifikovat rozpoznané citlivé informace v textu.

Tip

Language Studio můžete použít k vyzkoušení detekce PII v dokumentech, aniž byste museli psát kód.

Požadavky

Nastavení

Vytvoření prostředku Azure

Pokud chcete použít níže uvedený vzorový kód, budete muset nasadit prostředek Azure. Tento prostředek bude obsahovat klíč a koncový bod, které použijete k ověření volání rozhraní API, která odesíláte do služby Language.

  1. Pomocí následujícího odkazu vytvořte prostředek jazyka pomocí webu Azure Portal. Budete se muset přihlásit pomocí svého předplatného Azure.

  2. Na obrazovce Vybrat další funkce, která se zobrazí, vyberte Pokračovat a vytvořte prostředek.

    Snímek obrazovky s dalšími možnostmi funkcí na webu Azure Portal

  3. Na obrazovce Vytvořit jazyk zadejte následující informace:

    Detail Popis
    Předplatné Účet předplatného, ke kterému bude váš prostředek přidružený. V rozevírací nabídce vyberte své předplatné Azure.
    Skupina prostředků Skupina prostředků je kontejner, který ukládá prostředky, které vytvoříte. Vyberte Vytvořit novou a vytvořte novou skupinu prostředků.
    Oblast Umístění vašeho prostředku Jazyk. Různé oblasti můžou v závislosti na fyzickém umístění zavádět latenci, ale nemají žádný vliv na dostupnost modulu runtime vašeho prostředku. Pro účely tohoto rychlého startu vyberte dostupnou oblast blízko vás nebo zvolte USA – východ.
    Název Název vašeho prostředku jazyka Tento název se také použije k vytvoření adresy URL koncového bodu, kterou budou vaše aplikace používat k odesílání požadavků rozhraní API.
    Cenová úroveň Cenová úroveň vašeho prostředku Jazyk. Pomocí úrovně Free F0 můžete službu vyzkoušet a upgradovat na placenou úroveň pro produkční prostředí.

    Snímek obrazovky znázorňující podrobnosti o vytvoření prostředku na webu Azure Portal

  4. Ujistěte se, že je zaškrtnuté políčko Zodpovědné oznámení O umělé inteligenci.

  5. V dolní části stránky vyberte Zkontrolovat a vytvořit .

  6. Na obrazovce, která se zobrazí, se ujistěte, že ověření proběhlo a že jste správně zadali informace. Pak vyberte Vytvořit.

Získání klíče a koncového bodu

Dále budete potřebovat klíč a koncový bod z prostředku pro připojení aplikace k rozhraní API. Klíč a koncový bod vložíte do kódu později v rychlém startu.

  1. Po úspěšném nasazení prostředku jazyka klikněte v části Další kroky na tlačítko Přejít k prostředku.

    Snímek obrazovky znázorňující další kroky po nasazení prostředku

  2. Na obrazovce vašeho prostředku vyberte klíče a koncový bod v levé navigační nabídce. V následujících krocích použijete jeden ze svých klíčů a koncový bod.

    Snímek obrazovky znázorňující oddíl klíčů a koncového bodu prostředku

Vytvoření proměnných prostředí

Aby vaše aplikace odesílala požadavky rozhraní API, musí být ověřená. V produkčním prostředí použijte bezpečný způsob ukládání a přístupu k vašim přihlašovacím údajům. V tomto příkladu zapíšete přihlašovací údaje do proměnných prostředí na místním počítači, na kterém běží aplikace.

Tip

Nezahrňte klíč přímo do kódu a nikdy ho nesdělujte veřejně. Další možnosti ověřování, jako je Azure Key Vault, najdete v článku zabezpečení služeb Azure AI.

Pokud chcete nastavit proměnnou prostředí pro klíč prostředku jazyka, otevřete okno konzoly a postupujte podle pokynů pro operační systém a vývojové prostředí.

  1. Pokud chcete nastavit proměnnou LANGUAGE_KEY prostředí, nahraďte your-key jedním z klíčů pro váš prostředek.
  2. Pokud chcete nastavit proměnnou LANGUAGE_ENDPOINT prostředí, nahraďte your-endpoint koncovým bodem vašeho prostředku.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Poznámka:

Pokud potřebujete přístup pouze k proměnným prostředí v aktuální spuštěné konzole, můžete nastavit proměnnou set prostředí namísto setx.

Po přidání proměnných prostředí možná budete muset restartovat všechny spuštěné programy, které budou muset číst proměnné prostředí, včetně okna konzoly. Pokud například jako editor používáte Sadu Visual Studio, restartujte sadu Visual Studio před spuštěním příkladu.

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. Potom kód spusťte.

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

Výstup

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

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

V tomto rychlém startu můžete vytvořit aplikaci pro detekci osobních údajů (PII) s klientskou knihovnou pro Node.js. V následujícím příkladu vytvoříte javascriptovou aplikaci, která dokáže identifikovat rozpoznané citlivé informace v textu.

Požadavky

  • Předplatné Azure: Můžete si ho vytvořit zdarma.
  • Node.js verze 14 LTS nebo novější

Nastavení

Vytvoření prostředku Azure

Pokud chcete použít níže uvedený vzorový kód, budete muset nasadit prostředek Azure. Tento prostředek bude obsahovat klíč a koncový bod, které použijete k ověření volání rozhraní API, která odesíláte do služby Language.

  1. Pomocí následujícího odkazu vytvořte prostředek jazyka pomocí webu Azure Portal. Budete se muset přihlásit pomocí svého předplatného Azure.

  2. Na obrazovce Vybrat další funkce, která se zobrazí, vyberte Pokračovat a vytvořte prostředek.

    Snímek obrazovky s dalšími možnostmi funkcí na webu Azure Portal

  3. Na obrazovce Vytvořit jazyk zadejte následující informace:

    Detail Popis
    Předplatné Účet předplatného, ke kterému bude váš prostředek přidružený. V rozevírací nabídce vyberte své předplatné Azure.
    Skupina prostředků Skupina prostředků je kontejner, který ukládá prostředky, které vytvoříte. Vyberte Vytvořit novou a vytvořte novou skupinu prostředků.
    Oblast Umístění vašeho prostředku Jazyk. Různé oblasti můžou v závislosti na fyzickém umístění zavádět latenci, ale nemají žádný vliv na dostupnost modulu runtime vašeho prostředku. Pro účely tohoto rychlého startu vyberte dostupnou oblast blízko vás nebo zvolte USA – východ.
    Název Název vašeho prostředku jazyka Tento název se také použije k vytvoření adresy URL koncového bodu, kterou budou vaše aplikace používat k odesílání požadavků rozhraní API.
    Cenová úroveň Cenová úroveň vašeho prostředku Jazyk. Pomocí úrovně Free F0 můžete službu vyzkoušet a upgradovat na placenou úroveň pro produkční prostředí.

    Snímek obrazovky znázorňující podrobnosti o vytvoření prostředku na webu Azure Portal

  4. Ujistěte se, že je zaškrtnuté políčko Zodpovědné oznámení O umělé inteligenci.

  5. V dolní části stránky vyberte Zkontrolovat a vytvořit .

  6. Na obrazovce, která se zobrazí, se ujistěte, že ověření proběhlo a že jste správně zadali informace. Pak vyberte Vytvořit.

Získání klíče a koncového bodu

Dále budete potřebovat klíč a koncový bod z prostředku pro připojení aplikace k rozhraní API. Klíč a koncový bod vložíte do kódu později v rychlém startu.

  1. Po úspěšném nasazení prostředku jazyka klikněte v části Další kroky na tlačítko Přejít k prostředku.

    Snímek obrazovky znázorňující další kroky po nasazení prostředku

  2. Na obrazovce vašeho prostředku vyberte klíče a koncový bod v levé navigační nabídce. V následujících krocích použijete jeden ze svých klíčů a koncový bod.

    Snímek obrazovky znázorňující oddíl klíčů a koncového bodu prostředku

Vytvoření proměnných prostředí

Aby vaše aplikace odesílala požadavky rozhraní API, musí být ověřená. V produkčním prostředí použijte bezpečný způsob ukládání a přístupu k vašim přihlašovacím údajům. V tomto příkladu zapíšete přihlašovací údaje do proměnných prostředí na místním počítači, na kterém běží aplikace.

Tip

Nezahrňte klíč přímo do kódu a nikdy ho nesdělujte veřejně. Další možnosti ověřování, jako je Azure Key Vault, najdete v článku zabezpečení služeb Azure AI.

Pokud chcete nastavit proměnnou prostředí pro klíč prostředku jazyka, otevřete okno konzoly a postupujte podle pokynů pro operační systém a vývojové prostředí.

  1. Pokud chcete nastavit proměnnou LANGUAGE_KEY prostředí, nahraďte your-key jedním z klíčů pro váš prostředek.
  2. Pokud chcete nastavit proměnnou LANGUAGE_ENDPOINT prostředí, nahraďte your-endpoint koncovým bodem vašeho prostředku.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Poznámka:

Pokud potřebujete přístup pouze k proměnným prostředí v aktuální spuštěné konzole, můžete nastavit proměnnou set prostředí namísto setx.

Po přidání proměnných prostředí možná budete muset restartovat všechny spuštěné programy, které budou muset číst proměnné prostředí, včetně okna konzoly. Pokud například jako editor používáte Sadu Visual Studio, restartujte sadu Visual Studio před spuštěním příkladu.

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

Příklad kódu

Otevřete soubor a zkopírujte následující kód. Potom kód spusťte.

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

Výstup

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

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

Pomocí tohoto rychlého startu vytvoříte aplikaci pro rozpoznávání osobních údajů (PII) s klientskou knihovnou pro Python. V následujícím příkladu vytvoříte aplikaci Pythonu, která dokáže identifikovat rozpoznané citlivé informace v textu.

Požadavky

Nastavení

Vytvoření prostředku Azure

Pokud chcete použít níže uvedený vzorový kód, budete muset nasadit prostředek Azure. Tento prostředek bude obsahovat klíč a koncový bod, které použijete k ověření volání rozhraní API, která odesíláte do služby Language.

  1. Pomocí následujícího odkazu vytvořte prostředek jazyka pomocí webu Azure Portal. Budete se muset přihlásit pomocí svého předplatného Azure.

  2. Na obrazovce Vybrat další funkce, která se zobrazí, vyberte Pokračovat a vytvořte prostředek.

    Snímek obrazovky s dalšími možnostmi funkcí na webu Azure Portal

  3. Na obrazovce Vytvořit jazyk zadejte následující informace:

    Detail Popis
    Předplatné Účet předplatného, ke kterému bude váš prostředek přidružený. V rozevírací nabídce vyberte své předplatné Azure.
    Skupina prostředků Skupina prostředků je kontejner, který ukládá prostředky, které vytvoříte. Vyberte Vytvořit novou a vytvořte novou skupinu prostředků.
    Oblast Umístění vašeho prostředku Jazyk. Různé oblasti můžou v závislosti na fyzickém umístění zavádět latenci, ale nemají žádný vliv na dostupnost modulu runtime vašeho prostředku. Pro účely tohoto rychlého startu vyberte dostupnou oblast blízko vás nebo zvolte USA – východ.
    Název Název vašeho prostředku jazyka Tento název se také použije k vytvoření adresy URL koncového bodu, kterou budou vaše aplikace používat k odesílání požadavků rozhraní API.
    Cenová úroveň Cenová úroveň vašeho prostředku Jazyk. Pomocí úrovně Free F0 můžete službu vyzkoušet a upgradovat na placenou úroveň pro produkční prostředí.

    Snímek obrazovky znázorňující podrobnosti o vytvoření prostředku na webu Azure Portal

  4. Ujistěte se, že je zaškrtnuté políčko Zodpovědné oznámení O umělé inteligenci.

  5. V dolní části stránky vyberte Zkontrolovat a vytvořit .

  6. Na obrazovce, která se zobrazí, se ujistěte, že ověření proběhlo a že jste správně zadali informace. Pak vyberte Vytvořit.

Získání klíče a koncového bodu

Dále budete potřebovat klíč a koncový bod z prostředku pro připojení aplikace k rozhraní API. Klíč a koncový bod vložíte do kódu později v rychlém startu.

  1. Po úspěšném nasazení prostředku jazyka klikněte v části Další kroky na tlačítko Přejít k prostředku.

    Snímek obrazovky znázorňující další kroky po nasazení prostředku

  2. Na obrazovce vašeho prostředku vyberte klíče a koncový bod v levé navigační nabídce. V následujících krocích použijete jeden ze svých klíčů a koncový bod.

    Snímek obrazovky znázorňující oddíl klíčů a koncového bodu prostředku

Vytvoření proměnných prostředí

Aby vaše aplikace odesílala požadavky rozhraní API, musí být ověřená. V produkčním prostředí použijte bezpečný způsob ukládání a přístupu k vašim přihlašovacím údajům. V tomto příkladu zapíšete přihlašovací údaje do proměnných prostředí na místním počítači, na kterém běží aplikace.

Tip

Nezahrňte klíč přímo do kódu a nikdy ho nesdělujte veřejně. Další možnosti ověřování, jako je Azure Key Vault, najdete v článku zabezpečení služeb Azure AI.

Pokud chcete nastavit proměnnou prostředí pro klíč prostředku jazyka, otevřete okno konzoly a postupujte podle pokynů pro operační systém a vývojové prostředí.

  1. Pokud chcete nastavit proměnnou LANGUAGE_KEY prostředí, nahraďte your-key jedním z klíčů pro váš prostředek.
  2. Pokud chcete nastavit proměnnou LANGUAGE_ENDPOINT prostředí, nahraďte your-endpoint koncovým bodem vašeho prostředku.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Poznámka:

Pokud potřebujete přístup pouze k proměnným prostředí v aktuální spuštěné konzole, můžete nastavit proměnnou set prostředí namísto setx.

Po přidání proměnných prostředí možná budete muset restartovat všechny spuštěné programy, které budou muset číst proměnné prostředí, včetně okna konzoly. Pokud například jako editor používáte Sadu Visual Studio, restartujte sadu Visual Studio před spuštěním příkladu.

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. Potom kód spusťte.

# 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)

Výstup

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

Referenční dokumentace

Pomocí tohoto rychlého startu můžete pomocí rozhraní REST API odesílat žádosti o detekci identifikovatelných osobních údajů (PII). V následujícím příkladu použijete cURL k identifikaci rozpoznané citlivé informace v textu.

Požadavky

Nastavení

Vytvoření prostředku Azure

Pokud chcete použít níže uvedený vzorový kód, budete muset nasadit prostředek Azure. Tento prostředek bude obsahovat klíč a koncový bod, které použijete k ověření volání rozhraní API, která odesíláte do služby Language.

  1. Pomocí následujícího odkazu vytvořte prostředek jazyka pomocí webu Azure Portal. Budete se muset přihlásit pomocí svého předplatného Azure.

  2. Na obrazovce Vybrat další funkce, která se zobrazí, vyberte Pokračovat a vytvořte prostředek.

    Snímek obrazovky s dalšími možnostmi funkcí na webu Azure Portal

  3. Na obrazovce Vytvořit jazyk zadejte následující informace:

    Detail Popis
    Předplatné Účet předplatného, ke kterému bude váš prostředek přidružený. V rozevírací nabídce vyberte své předplatné Azure.
    Skupina prostředků Skupina prostředků je kontejner, který ukládá prostředky, které vytvoříte. Vyberte Vytvořit novou a vytvořte novou skupinu prostředků.
    Oblast Umístění vašeho prostředku Jazyk. Různé oblasti můžou v závislosti na fyzickém umístění zavádět latenci, ale nemají žádný vliv na dostupnost modulu runtime vašeho prostředku. Pro účely tohoto rychlého startu vyberte dostupnou oblast blízko vás nebo zvolte USA – východ.
    Název Název vašeho prostředku jazyka Tento název se také použije k vytvoření adresy URL koncového bodu, kterou budou vaše aplikace používat k odesílání požadavků rozhraní API.
    Cenová úroveň Cenová úroveň vašeho prostředku Jazyk. Pomocí úrovně Free F0 můžete službu vyzkoušet a upgradovat na placenou úroveň pro produkční prostředí.

    Snímek obrazovky znázorňující podrobnosti o vytvoření prostředku na webu Azure Portal

  4. Ujistěte se, že je zaškrtnuté políčko Zodpovědné oznámení O umělé inteligenci.

  5. V dolní části stránky vyberte Zkontrolovat a vytvořit .

  6. Na obrazovce, která se zobrazí, se ujistěte, že ověření proběhlo a že jste správně zadali informace. Pak vyberte Vytvořit.

Získání klíče a koncového bodu

Dále budete potřebovat klíč a koncový bod z prostředku pro připojení aplikace k rozhraní API. Klíč a koncový bod vložíte do kódu později v rychlém startu.

  1. Po úspěšném nasazení prostředku jazyka klikněte v části Další kroky na tlačítko Přejít k prostředku.

    Snímek obrazovky znázorňující další kroky po nasazení prostředku

  2. Na obrazovce vašeho prostředku vyberte klíče a koncový bod v levé navigační nabídce. V následujících krocích použijete jeden ze svých klíčů a koncový bod.

    Snímek obrazovky znázorňující oddíl klíčů a koncového bodu prostředku

Vytvoření proměnných prostředí

Aby vaše aplikace odesílala požadavky rozhraní API, musí být ověřená. V produkčním prostředí použijte bezpečný způsob ukládání a přístupu k vašim přihlašovacím údajům. V tomto příkladu zapíšete přihlašovací údaje do proměnných prostředí na místním počítači, na kterém běží aplikace.

Tip

Nezahrňte klíč přímo do kódu a nikdy ho nesdělujte veřejně. Další možnosti ověřování, jako je Azure Key Vault, najdete v článku zabezpečení služeb Azure AI.

Pokud chcete nastavit proměnnou prostředí pro klíč prostředku jazyka, otevřete okno konzoly a postupujte podle pokynů pro operační systém a vývojové prostředí.

  1. Pokud chcete nastavit proměnnou LANGUAGE_KEY prostředí, nahraďte your-key jedním z klíčů pro váš prostředek.
  2. Pokud chcete nastavit proměnnou LANGUAGE_ENDPOINT prostředí, nahraďte your-endpoint koncovým bodem vašeho prostředku.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Poznámka:

Pokud potřebujete přístup pouze k proměnným prostředí v aktuální spuštěné konzole, můžete nastavit proměnnou set prostředí namísto setx.

Po přidání proměnných prostředí možná budete muset restartovat všechny spuštěné programy, které budou muset číst proměnné prostředí, včetně okna konzoly. Pokud například jako editor používáte Sadu Visual Studio, restartujte sadu Visual Studio před spuštěním příkladu.

Vytvoření souboru JSON s ukázkovým textem požadavku

V editoru kódu vytvořte nový soubor s názvem test_pii_payload.json a zkopírujte následující příklad JSON. Tento ukázkový požadavek se odešle do rozhraní API v dalším kroku.

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

Uložte test_pii_payload.json si někam do počítače. Například vaše plocha.

Odeslání požadavku rozhraní API pro rozpoznávání osobních údajů (PII)

Pomocí následujících příkazů odešlete požadavek rozhraní API pomocí programu, který používáte. Zkopírujte příkaz do terminálu a spusťte ho.

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.

Nahraďte C:\Users\<myaccount>\Desktop\test_pii_payload.json umístěním ukázkového souboru požadavku JSON, který jste vytvořili v předchozím kroku.

Příkazový řádek

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"

Odpověď JSON

{
	"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"
	}
}

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