Guia de início rápido: detetar informações pessoalmente identificáveis (PII)

  • Artigo

Nota

Este guia de início rápido cobre apenas a deteção de PII em documentos. Para saber mais sobre como detetar PII em conversas, consulte Como detetar e redigir PII em conversas.

Documentação | de referência Mais exemplos | Pacote (NuGet) | Código fonte da biblioteca

Use este guia de início rápido para criar um aplicativo de deteção de informações pessoalmente identificáveis (PII) com a biblioteca de cliente para .NET. No exemplo a seguir, você cria um aplicativo C# que pode identificar informações confidenciais reconhecidas no texto.

Gorjeta

Você pode usar o Language Studio para tentar a deteção de PII em documentos sem precisar escrever código.

Pré-requisitos

Configuração

Criar um recurso do Azure

Para usar o exemplo de código abaixo, você precisará implantar um recurso do Azure. Este recurso conterá uma chave e um ponto de extremidade que você usará para autenticar as chamadas de API enviadas ao serviço de idiomas.

  1. Use o link a seguir para criar um recurso de idioma usando o portal do Azure. Você precisará entrar usando sua assinatura do Azure.

  2. Na tela Selecionar recursos adicionais exibida, selecione Continuar para criar seu recurso.

    Uma captura de tela mostrando opções de recursos adicionais no portal do Azure.

  3. Na tela Criar idioma, forneça as seguintes informações:

    Detalhe Description
    Subscrição A conta de subscrição à qual o seu recurso será associado. Selecione sua assinatura do Azure no menu suspenso.
    Grupo de recursos Um grupo de recursos é um contêiner que armazena os recursos criados. Selecione Criar novo para criar um novo grupo de recursos.
    País/Região A localização do seu recurso de idioma. Regiões diferentes podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade de tempo de execução do seu recurso. Para este início rápido, selecione uma região disponível perto de você ou escolha Leste dos EUA.
    Nome O nome do recurso Idioma. Esse nome também será usado para criar uma URL de ponto de extremidade que seus aplicativos usarão para enviar solicitações de API.
    Escalão de preço A camada de preço para seu recurso de idioma. Você pode usar a camada F0 gratuita para experimentar o serviço e atualizar mais tarde para uma camada paga para produção.

    Uma captura de tela mostrando detalhes de criação de recursos no portal do Azure.

  4. Verifique se a caixa de seleção Aviso de IA Responsável está marcada.

  5. Selecione Rever + Criar na parte inferior da página.

  6. No ecrã apresentado, certifique-se de que a validação foi aprovada e de que introduziu as suas informações corretamente. Depois, selecione Criar.

Obtenha a sua chave e o seu ponto final

Em seguida, você precisará da chave e do ponto de extremidade do recurso para conectar seu aplicativo à API. Você colará sua chave e ponto de extremidade no código mais tarde no início rápido.

  1. Depois que o recurso de idioma for implantado com êxito, clique no botão Ir para recurso em Próximas etapas.

    Uma captura de tela mostrando as próximas etapas após a implantação de um recurso.

  2. Na tela do seu recurso, selecione Chaves e ponto de extremidade no menu de navegação à esquerda. Você usará uma de suas chaves e seu endpoint nas etapas abaixo.

    Uma captura de tela mostrando as chaves e a seção de ponto de extremidade de um recurso.

Criar variáveis de ambiente

Seu aplicativo deve ser autenticado para enviar solicitações de API. Para produção, use uma maneira segura de armazenar e acessar suas credenciais. Neste exemplo, você gravará suas credenciais em variáveis de ambiente na máquina local que executa o aplicativo.

Gorjeta

Não inclua a chave diretamente no seu código e nunca a publique publicamente. Consulte o artigo de segurança dos serviços de IA do Azure para obter mais opções de autenticação, como o Azure Key Vault.

Para definir a variável de ambiente para sua chave de recurso de idioma, abra uma janela de console e siga as instruções para seu sistema operacional e ambiente de desenvolvimento.

  1. Para definir a LANGUAGE_KEY variável de ambiente, substitua your-key por uma das chaves do seu recurso.
  2. Para definir a variável de LANGUAGE_ENDPOINT ambiente, substitua your-endpoint pelo ponto de extremidade do seu recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota

Se você só precisar acessar as variáveis de ambiente no console em execução atual, poderá definir a variável de ambiente com set em vez de setx.

Depois de adicionar as variáveis de ambiente, talvez seja necessário reiniciar todos os programas em execução que precisarão ler as variáveis de ambiente, incluindo a janela do console. Por exemplo, se você estiver usando o Visual Studio como editor, reinicie o Visual Studio antes de executar o exemplo.

Criar uma nova aplicação .NET Core

Com o IDE do Visual Studio, crie uma nova aplicação de consola .NET Core. Isso cria um projeto "Hello World" com um único arquivo de origem C#: program.cs.

Instale a biblioteca de cliente, clicando com o botão direito do rato na solução no Explorador de Soluções e selecionando Gerir Pacotes NuGet. No gerenciador de pacotes que é aberto, selecione Procurar e procure Azure.AI.TextAnalytics. Selecione a versão 5.2.0 e, em seguida, Instalar. Também pode utilizar a Consola do Gestor de Pacotes.

Exemplo de código

Copie o código a seguir para o arquivo program.cs e execute o código.

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

    }
}

Saída

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

Documentação | de referência Mais exemplos | Pacote (Maven) | Código fonte da biblioteca

Use este início rápido para criar um aplicativo de deteção de informações pessoalmente identificáveis (PII) com a biblioteca de cliente para Java. No exemplo a seguir, você cria um aplicativo Java que pode identificar informações confidenciais reconhecidas em texto.

Gorjeta

Você pode usar o Language Studio para tentar a deteção de PII em documentos sem precisar escrever código.

Pré-requisitos

Configuração

Criar um recurso do Azure

Para usar o exemplo de código abaixo, você precisará implantar um recurso do Azure. Este recurso conterá uma chave e um ponto de extremidade que você usará para autenticar as chamadas de API enviadas ao serviço de idiomas.

  1. Use o link a seguir para criar um recurso de idioma usando o portal do Azure. Você precisará entrar usando sua assinatura do Azure.

  2. Na tela Selecionar recursos adicionais exibida, selecione Continuar para criar seu recurso.

    Uma captura de tela mostrando opções de recursos adicionais no portal do Azure.

  3. Na tela Criar idioma, forneça as seguintes informações:

    Detalhe Description
    Subscrição A conta de subscrição à qual o seu recurso será associado. Selecione sua assinatura do Azure no menu suspenso.
    Grupo de recursos Um grupo de recursos é um contêiner que armazena os recursos criados. Selecione Criar novo para criar um novo grupo de recursos.
    País/Região A localização do seu recurso de idioma. Regiões diferentes podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade de tempo de execução do seu recurso. Para este início rápido, selecione uma região disponível perto de você ou escolha Leste dos EUA.
    Nome O nome do recurso Idioma. Esse nome também será usado para criar uma URL de ponto de extremidade que seus aplicativos usarão para enviar solicitações de API.
    Escalão de preço A camada de preço para seu recurso de idioma. Você pode usar a camada F0 gratuita para experimentar o serviço e atualizar mais tarde para uma camada paga para produção.

    Uma captura de tela mostrando detalhes de criação de recursos no portal do Azure.

  4. Verifique se a caixa de seleção Aviso de IA Responsável está marcada.

  5. Selecione Rever + Criar na parte inferior da página.

  6. No ecrã apresentado, certifique-se de que a validação foi aprovada e de que introduziu as suas informações corretamente. Depois, selecione Criar.

Obtenha a sua chave e o seu ponto final

Em seguida, você precisará da chave e do ponto de extremidade do recurso para conectar seu aplicativo à API. Você colará sua chave e ponto de extremidade no código mais tarde no início rápido.

  1. Depois que o recurso de idioma for implantado com êxito, clique no botão Ir para recurso em Próximas etapas.

    Uma captura de tela mostrando as próximas etapas após a implantação de um recurso.

  2. Na tela do seu recurso, selecione Chaves e ponto de extremidade no menu de navegação à esquerda. Você usará uma de suas chaves e seu endpoint nas etapas abaixo.

    Uma captura de tela mostrando as chaves e a seção de ponto de extremidade de um recurso.

Criar variáveis de ambiente

Seu aplicativo deve ser autenticado para enviar solicitações de API. Para produção, use uma maneira segura de armazenar e acessar suas credenciais. Neste exemplo, você gravará suas credenciais em variáveis de ambiente na máquina local que executa o aplicativo.

Gorjeta

Não inclua a chave diretamente no seu código e nunca a publique publicamente. Consulte o artigo de segurança dos serviços de IA do Azure para obter mais opções de autenticação, como o Azure Key Vault.

Para definir a variável de ambiente para sua chave de recurso de idioma, abra uma janela de console e siga as instruções para seu sistema operacional e ambiente de desenvolvimento.

  1. Para definir a LANGUAGE_KEY variável de ambiente, substitua your-key por uma das chaves do seu recurso.
  2. Para definir a variável de LANGUAGE_ENDPOINT ambiente, substitua your-endpoint pelo ponto de extremidade do seu recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota

Se você só precisar acessar as variáveis de ambiente no console em execução atual, poderá definir a variável de ambiente com set em vez de setx.

Depois de adicionar as variáveis de ambiente, talvez seja necessário reiniciar todos os programas em execução que precisarão ler as variáveis de ambiente, incluindo a janela do console. Por exemplo, se você estiver usando o Visual Studio como editor, reinicie o Visual Studio antes de executar o exemplo.

Adicionar a biblioteca de cliente

Crie um projeto do Maven no IDE ou ambiente de desenvolvimento da sua preferência. Em seguida, adicione a seguinte dependência ao ficheiro pom.xml do projeto. Pode encontrar a sintaxe de implementação para outras ferramentas de criação online.

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

Exemplo de código

Crie um ficheiro Java com o nome Example.java. Abra o arquivo e copie o código abaixo. Em seguida, execute o código.

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

Saída

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

Documentação | de referência Mais exemplos | Pacote (npm) | Código fonte da biblioteca

Use este guia de início rápido para criar um aplicativo de deteção de informações pessoalmente identificáveis (PII) com a biblioteca de cliente para Node.js. No exemplo a seguir, você cria um aplicativo JavaScript que pode identificar informações confidenciais reconhecidas no texto.

Pré-requisitos

Configuração

Criar um recurso do Azure

Para usar o exemplo de código abaixo, você precisará implantar um recurso do Azure. Este recurso conterá uma chave e um ponto de extremidade que você usará para autenticar as chamadas de API enviadas ao serviço de idiomas.

  1. Use o link a seguir para criar um recurso de idioma usando o portal do Azure. Você precisará entrar usando sua assinatura do Azure.

  2. Na tela Selecionar recursos adicionais exibida, selecione Continuar para criar seu recurso.

    Uma captura de tela mostrando opções de recursos adicionais no portal do Azure.

  3. Na tela Criar idioma, forneça as seguintes informações:

    Detalhe Description
    Subscrição A conta de subscrição à qual o seu recurso será associado. Selecione sua assinatura do Azure no menu suspenso.
    Grupo de recursos Um grupo de recursos é um contêiner que armazena os recursos criados. Selecione Criar novo para criar um novo grupo de recursos.
    País/Região A localização do seu recurso de idioma. Regiões diferentes podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade de tempo de execução do seu recurso. Para este início rápido, selecione uma região disponível perto de você ou escolha Leste dos EUA.
    Nome O nome do recurso Idioma. Esse nome também será usado para criar uma URL de ponto de extremidade que seus aplicativos usarão para enviar solicitações de API.
    Escalão de preço A camada de preço para seu recurso de idioma. Você pode usar a camada F0 gratuita para experimentar o serviço e atualizar mais tarde para uma camada paga para produção.

    Uma captura de tela mostrando detalhes de criação de recursos no portal do Azure.

  4. Verifique se a caixa de seleção Aviso de IA Responsável está marcada.

  5. Selecione Rever + Criar na parte inferior da página.

  6. No ecrã apresentado, certifique-se de que a validação foi aprovada e de que introduziu as suas informações corretamente. Depois, selecione Criar.

Obtenha a sua chave e o seu ponto final

Em seguida, você precisará da chave e do ponto de extremidade do recurso para conectar seu aplicativo à API. Você colará sua chave e ponto de extremidade no código mais tarde no início rápido.

  1. Depois que o recurso de idioma for implantado com êxito, clique no botão Ir para recurso em Próximas etapas.

    Uma captura de tela mostrando as próximas etapas após a implantação de um recurso.

  2. Na tela do seu recurso, selecione Chaves e ponto de extremidade no menu de navegação à esquerda. Você usará uma de suas chaves e seu endpoint nas etapas abaixo.

    Uma captura de tela mostrando as chaves e a seção de ponto de extremidade de um recurso.

Criar variáveis de ambiente

Seu aplicativo deve ser autenticado para enviar solicitações de API. Para produção, use uma maneira segura de armazenar e acessar suas credenciais. Neste exemplo, você gravará suas credenciais em variáveis de ambiente na máquina local que executa o aplicativo.

Gorjeta

Não inclua a chave diretamente no seu código e nunca a publique publicamente. Consulte o artigo de segurança dos serviços de IA do Azure para obter mais opções de autenticação, como o Azure Key Vault.

Para definir a variável de ambiente para sua chave de recurso de idioma, abra uma janela de console e siga as instruções para seu sistema operacional e ambiente de desenvolvimento.

  1. Para definir a LANGUAGE_KEY variável de ambiente, substitua your-key por uma das chaves do seu recurso.
  2. Para definir a variável de LANGUAGE_ENDPOINT ambiente, substitua your-endpoint pelo ponto de extremidade do seu recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota

Se você só precisar acessar as variáveis de ambiente no console em execução atual, poderá definir a variável de ambiente com set em vez de setx.

Depois de adicionar as variáveis de ambiente, talvez seja necessário reiniciar todos os programas em execução que precisarão ler as variáveis de ambiente, incluindo a janela do console. Por exemplo, se você estiver usando o Visual Studio como editor, reinicie o Visual Studio antes de executar o exemplo.

Criar uma nova aplicação Node.js

Numa janela de consola (como cmd, PowerShell ou Bash), crie um novo diretório para a sua aplicação e navegue para a mesma.

mkdir myapp 

cd myapp

Execute o comando npm init para criar uma aplicação de nó com um ficheiro package.json.

npm init

Instalar a biblioteca de cliente

Instale o pacote npm:

npm install @azure/ai-text-analytics

Exemplo de código

Abra o arquivo e copie o código abaixo. Em seguida, execute o código.

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

Saída

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

Documentação | de referência Mais exemplos | Pacote (PyPi) | Código fonte da biblioteca

Use este início rápido para criar um aplicativo de deteção de Informações Pessoalmente Identificáveis (PII) com a biblioteca de cliente para Python. No exemplo a seguir, você criará um aplicativo Python que pode identificar informações confidenciais reconhecidas no texto.

Pré-requisitos

Configuração

Criar um recurso do Azure

Para usar o exemplo de código abaixo, você precisará implantar um recurso do Azure. Este recurso conterá uma chave e um ponto de extremidade que você usará para autenticar as chamadas de API enviadas ao serviço de idiomas.

  1. Use o link a seguir para criar um recurso de idioma usando o portal do Azure. Você precisará entrar usando sua assinatura do Azure.

  2. Na tela Selecionar recursos adicionais exibida, selecione Continuar para criar seu recurso.

    Uma captura de tela mostrando opções de recursos adicionais no portal do Azure.

  3. Na tela Criar idioma, forneça as seguintes informações:

    Detalhe Description
    Subscrição A conta de subscrição à qual o seu recurso será associado. Selecione sua assinatura do Azure no menu suspenso.
    Grupo de recursos Um grupo de recursos é um contêiner que armazena os recursos criados. Selecione Criar novo para criar um novo grupo de recursos.
    País/Região A localização do seu recurso de idioma. Regiões diferentes podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade de tempo de execução do seu recurso. Para este início rápido, selecione uma região disponível perto de você ou escolha Leste dos EUA.
    Nome O nome do recurso Idioma. Esse nome também será usado para criar uma URL de ponto de extremidade que seus aplicativos usarão para enviar solicitações de API.
    Escalão de preço A camada de preço para seu recurso de idioma. Você pode usar a camada F0 gratuita para experimentar o serviço e atualizar mais tarde para uma camada paga para produção.

    Uma captura de tela mostrando detalhes de criação de recursos no portal do Azure.

  4. Verifique se a caixa de seleção Aviso de IA Responsável está marcada.

  5. Selecione Rever + Criar na parte inferior da página.

  6. No ecrã apresentado, certifique-se de que a validação foi aprovada e de que introduziu as suas informações corretamente. Depois, selecione Criar.

Obtenha a sua chave e o seu ponto final

Em seguida, você precisará da chave e do ponto de extremidade do recurso para conectar seu aplicativo à API. Você colará sua chave e ponto de extremidade no código mais tarde no início rápido.

  1. Depois que o recurso de idioma for implantado com êxito, clique no botão Ir para recurso em Próximas etapas.

    Uma captura de tela mostrando as próximas etapas após a implantação de um recurso.

  2. Na tela do seu recurso, selecione Chaves e ponto de extremidade no menu de navegação à esquerda. Você usará uma de suas chaves e seu endpoint nas etapas abaixo.

    Uma captura de tela mostrando as chaves e a seção de ponto de extremidade de um recurso.

Criar variáveis de ambiente

Seu aplicativo deve ser autenticado para enviar solicitações de API. Para produção, use uma maneira segura de armazenar e acessar suas credenciais. Neste exemplo, você gravará suas credenciais em variáveis de ambiente na máquina local que executa o aplicativo.

Gorjeta

Não inclua a chave diretamente no seu código e nunca a publique publicamente. Consulte o artigo de segurança dos serviços de IA do Azure para obter mais opções de autenticação, como o Azure Key Vault.

Para definir a variável de ambiente para sua chave de recurso de idioma, abra uma janela de console e siga as instruções para seu sistema operacional e ambiente de desenvolvimento.

  1. Para definir a LANGUAGE_KEY variável de ambiente, substitua your-key por uma das chaves do seu recurso.
  2. Para definir a variável de LANGUAGE_ENDPOINT ambiente, substitua your-endpoint pelo ponto de extremidade do seu recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota

Se você só precisar acessar as variáveis de ambiente no console em execução atual, poderá definir a variável de ambiente com set em vez de setx.

Depois de adicionar as variáveis de ambiente, talvez seja necessário reiniciar todos os programas em execução que precisarão ler as variáveis de ambiente, incluindo a janela do console. Por exemplo, se você estiver usando o Visual Studio como editor, reinicie o Visual Studio antes de executar o exemplo.

Instalar a biblioteca de cliente

Depois de instalar o Python, pode instalar a biblioteca de cliente com:

pip install azure-ai-textanalytics==5.2.0

Exemplo de código

Crie um novo arquivo Python e copie o código abaixo. Em seguida, execute o código.

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

Saída

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

Documentação de referência

Use este guia de início rápido para enviar solicitações de deteção de Informações de Identificação Pessoal (PII) usando a API REST. No exemplo a seguir, você usará cURL para identificar informações confidenciais reconhecidas no texto.

Pré-requisitos

Configuração

Criar um recurso do Azure

Para usar o exemplo de código abaixo, você precisará implantar um recurso do Azure. Este recurso conterá uma chave e um ponto de extremidade que você usará para autenticar as chamadas de API enviadas ao serviço de idiomas.

  1. Use o link a seguir para criar um recurso de idioma usando o portal do Azure. Você precisará entrar usando sua assinatura do Azure.

  2. Na tela Selecionar recursos adicionais exibida, selecione Continuar para criar seu recurso.

    Uma captura de tela mostrando opções de recursos adicionais no portal do Azure.

  3. Na tela Criar idioma, forneça as seguintes informações:

    Detalhe Description
    Subscrição A conta de subscrição à qual o seu recurso será associado. Selecione sua assinatura do Azure no menu suspenso.
    Grupo de recursos Um grupo de recursos é um contêiner que armazena os recursos criados. Selecione Criar novo para criar um novo grupo de recursos.
    País/Região A localização do seu recurso de idioma. Regiões diferentes podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade de tempo de execução do seu recurso. Para este início rápido, selecione uma região disponível perto de você ou escolha Leste dos EUA.
    Nome O nome do recurso Idioma. Esse nome também será usado para criar uma URL de ponto de extremidade que seus aplicativos usarão para enviar solicitações de API.
    Escalão de preço A camada de preço para seu recurso de idioma. Você pode usar a camada F0 gratuita para experimentar o serviço e atualizar mais tarde para uma camada paga para produção.

    Uma captura de tela mostrando detalhes de criação de recursos no portal do Azure.

  4. Verifique se a caixa de seleção Aviso de IA Responsável está marcada.

  5. Selecione Rever + Criar na parte inferior da página.

  6. No ecrã apresentado, certifique-se de que a validação foi aprovada e de que introduziu as suas informações corretamente. Depois, selecione Criar.

Obtenha a sua chave e o seu ponto final

Em seguida, você precisará da chave e do ponto de extremidade do recurso para conectar seu aplicativo à API. Você colará sua chave e ponto de extremidade no código mais tarde no início rápido.

  1. Depois que o recurso de idioma for implantado com êxito, clique no botão Ir para recurso em Próximas etapas.

    Uma captura de tela mostrando as próximas etapas após a implantação de um recurso.

  2. Na tela do seu recurso, selecione Chaves e ponto de extremidade no menu de navegação à esquerda. Você usará uma de suas chaves e seu endpoint nas etapas abaixo.

    Uma captura de tela mostrando as chaves e a seção de ponto de extremidade de um recurso.

Criar variáveis de ambiente

Seu aplicativo deve ser autenticado para enviar solicitações de API. Para produção, use uma maneira segura de armazenar e acessar suas credenciais. Neste exemplo, você gravará suas credenciais em variáveis de ambiente na máquina local que executa o aplicativo.

Gorjeta

Não inclua a chave diretamente no seu código e nunca a publique publicamente. Consulte o artigo de segurança dos serviços de IA do Azure para obter mais opções de autenticação, como o Azure Key Vault.

Para definir a variável de ambiente para sua chave de recurso de idioma, abra uma janela de console e siga as instruções para seu sistema operacional e ambiente de desenvolvimento.

  1. Para definir a LANGUAGE_KEY variável de ambiente, substitua your-key por uma das chaves do seu recurso.
  2. Para definir a variável de LANGUAGE_ENDPOINT ambiente, substitua your-endpoint pelo ponto de extremidade do seu recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota

Se você só precisar acessar as variáveis de ambiente no console em execução atual, poderá definir a variável de ambiente com set em vez de setx.

Depois de adicionar as variáveis de ambiente, talvez seja necessário reiniciar todos os programas em execução que precisarão ler as variáveis de ambiente, incluindo a janela do console. Por exemplo, se você estiver usando o Visual Studio como editor, reinicie o Visual Studio antes de executar o exemplo.

Criar um arquivo JSON com o corpo da solicitação de exemplo

Em um editor de códigos, crie um novo arquivo chamado test_pii_payload.json e copie o exemplo JSON a seguir. Esta solicitação de exemplo será enviada para a API na próxima etapa.

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

Guarde test_pii_payload.json algures no seu computador. Por exemplo, o seu ambiente de trabalho.

Enviar uma solicitação de API de deteção de informações de identificação pessoal (PII)

Use os comandos a seguir para enviar a solicitação de API usando o programa que você está usando. Copie o comando para o terminal e execute-o.

parâmetro Description
-X POST <endpoint> Especifica seu ponto de extremidade para acessar a API.
-H Content-Type: application/json O tipo de conteúdo para enviar dados JSON.
-H "Ocp-Apim-Subscription-Key:<key> Especifica a chave para acessar a API.
-d <documents> O JSON que contém os documentos que você deseja enviar.

Substitua C:\Users\<myaccount>\Desktop\test_pii_payload.json pelo local do arquivo de solicitação JSON de exemplo criado na etapa anterior.

Linha de comandos

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"

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

Clean up resources (Limpar recursos)

Se quiser limpar e remover uma assinatura de serviços do Azure AI, você pode excluir o recurso ou grupo de recursos. A exclusão do grupo de recursos também exclui quaisquer outros recursos associados a ele.

Próximos passos