Início Rápido: Detectar PII (informações de identificação pessoal)
Observação
Este início rápido aborda apenas a detecção de PII em documentos. Para saber como detectar PII em conversas, confira Como detectar e redigir PII em conversas.
Documentação de referência | Amostras adicionais | Pacote (NuGet) | Código-fonte da biblioteca
Use este início rápido para criar um aplicativo de detecção PII (Informações de Identificação Pessoal) com a biblioteca de clientes para .NET. No exemplo a seguir, você criará um aplicativo C# que pode identificar informações confidenciais reconhecidas no texto.
Dica
Você pode usar o Language Studio para tentar realizar detecção de PII em documentos sem a necessidade de escrever código.
Pré-requisitos
- Assinatura do Azure – Criar uma gratuitamente
- O IDE do Visual Studio
- Após obter sua assinatura do Azure, crie um recurso de Linguagem no portal do Azure para obter a chave e o ponto de extremidade. Após a implantação, selecione Ir para recurso.
- Você precisará da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Cole a chave e o ponto de extremidade no código abaixo mais adiante no guia de início rápido.
- Use o tipo de preço gratuito (
Free F0
) para experimentar o serviço e atualizar mais tarde para um nível pago para produção.
- Para usar o recurso Analisar, você precisará de um recurso de Linguagem de programação com o tipo de preço S (Standard).
Configurando
Criar um aplicativo .NET Core
Usando o IDE do Visual Studio, crie um aplicativo de console do .NET Core. Isso criará um projeto "Olá, Mundo" com um arquivo de origem C#: program.cs.
Instale a biblioteca de cliente clicando com o botão direito do mouse na solução no Gerenciador de Soluções e selecionando Gerenciar Pacotes do NuGet. No gerenciador de pacotes que é aberto, selecione Procurar e pesquise por Azure.AI.TextAnalytics
. Selecione a versão 5.2.0
e, em seguida, Instalar. Você também pode usar o Console do Gerenciador de Pacotes.
Exemplo de código
Copie o código a seguir para o arquivo program.cs. Lembre-se de substituir a variável key
pela chave do recurso e substituir a variável endpoint
pelo ponto de extremidade do recurso.
Importante
Vá para o portal do Azure. Se o recurso de Linguagem que você criou na seção Pré-requisitos tiver sido implantado com êxito, clique no botão Ir para o recurso em Próximas Etapas. Para encontrar a chave e o ponto de extremidade, acesse a página Chaves e Ponto de Extremidade do recurso em Gerenciamento de Recursos.
Importante
Lembre-se de remover a chave do seu código quando terminar e nunca poste-a publicamente. Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Confira o artigo sobre segurança dos serviços de IA do Azure para obter mais informações.
using Azure;
using System;
using Azure.AI.TextAnalytics;
namespace Example
{
class Program
{
private static readonly AzureKeyCredential credentials = new AzureKeyCredential("replace-with-your-key-here");
private static readonly Uri endpoint = new Uri("replace-with-your-endpoint-here");
// Example method for 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 | Amostras adicionais | Pacote (Maven) | Código-fonte da biblioteca
Use este início rápido para criar um aplicativo de detecção PII (Informações de Identificação Pessoal) com a biblioteca de clientes para Java. No exemplo a seguir, você criará um aplicativo Java que pode identificar informações confidenciais reconhecidas no texto.
Dica
Você pode usar o Language Studio para tentar realizar detecção de PII em documentos sem a necessidade de escrever código.
Pré-requisitos
- Assinatura do Azure – Criar uma gratuitamente
- JDK (Java Development Kit) com a versão 8 ou superior
- Após obter sua assinatura do Azure, crie um recurso de Linguagem no portal do Azure para obter a chave e o ponto de extremidade. Após a implantação, selecione Ir para recurso.
- Você precisará da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Cole a chave e o ponto de extremidade no código abaixo mais adiante no guia de início rápido.
- Use o tipo de preço gratuito (
Free F0
) para experimentar o serviço e atualizar mais tarde para um nível pago para produção.
- Para usar o recurso Analisar, você precisará de um recurso de Linguagem de programação com o tipo de preço S (Standard).
Configurando
Adicionar a biblioteca de clientes
Crie um projeto Maven no IDE ou no ambiente de desenvolvimento de sua preferência. Em seguida, adicione a dependência a seguir ao arquivo pom.xml do projeto. Você pode encontrar a sintaxe de implementação para outras ferramentas de build 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 arquivo Java chamado Example.java
. Abra o arquivo e copie o código abaixo. Lembre-se de substituir a variável key
pela chave do recurso e substituir a variável endpoint
pelo ponto de extremidade do recurso.
Importante
Vá para o portal do Azure. Se o recurso de Linguagem que você criou na seção Pré-requisitos tiver sido implantado com êxito, clique no botão Ir para o recurso em Próximas Etapas. Para encontrar a chave e o ponto de extremidade, acesse a página Chaves e Ponto de Extremidade do recurso em Gerenciamento de Recursos.
Importante
Lembre-se de remover a chave do seu código quando terminar e nunca poste-a publicamente. Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Confira o artigo sobre segurança dos serviços de IA do Azure para obter mais informações.
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 {
private static String KEY = "replace-with-your-key-here";
private static String ENDPOINT = "replace-with-your-endpoint-here";
public static void main(String[] args) {
TextAnalyticsClient client = authenticateClient(KEY, ENDPOINT);
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 | Amostras adicionais | Pacote (npm) | Código-fonte da biblioteca
Use este início rápido para criar um aplicativo de detecção PII (Informações de Identificação Pessoal) com a biblioteca de clientes para Node.js. No exemplo a seguir, você criará um aplicativo JavaScript que pode identificar informações confidenciais reconhecidas no texto.
Dica
Você pode usar o Language Studio para tentar realizar detecção de PII em documentos sem a necessidade de escrever código.
Pré-requisitos
- Assinatura do Azure – Criar uma gratuitamente
- Node.js v14 LTS ou posterior
- Após obter sua assinatura do Azure, crie um recurso de Linguagem no portal do Azure para obter a chave e o ponto de extremidade. Após a implantação, selecione Ir para recurso.
- você precisará da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Cole a chave e o ponto de extremidade no código abaixo mais adiante no guia de início rápido.
- Use o tipo de preço gratuito (
Free F0
) para experimentar o serviço e atualizar mais tarde para um nível pago para produção.
- Para usar o recurso Analisar, você precisará de um recurso de Linguagem de programação com o tipo de preço S (Standard).
Configurando
Criar um novo aplicativo do Node.js
Em uma janela de console (como cmd, PowerShell ou Bash), crie um novo diretório para seu aplicativo e navegue até ele.
mkdir myapp
cd myapp
Execute o comando npm init
para criar um aplicativo do Node com um arquivo package.json
.
npm init
Instalar a biblioteca de clientes
Instale o pacote npm:
npm install @azure/ai-text-analytics
Exemplo de código
Abra o arquivo e copie o código abaixo. Lembre-se de substituir a variável key
pela chave do recurso e substituir a variável endpoint
pelo ponto de extremidade do recurso.
Importante
Vá para o portal do Azure. Se o recurso de Linguagem que você criou na seção Pré-requisitos tiver sido implantado com êxito, clique no botão Ir para o recurso em Próximas Etapas. Para encontrar a chave e o ponto de extremidade, acesse a página Chaves e Ponto de Extremidade do recurso em Gerenciamento de Recursos.
Importante
Lembre-se de remover a chave do seu código quando terminar e nunca poste-a publicamente. Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Confira o artigo sobre segurança dos serviços de IA do Azure para obter mais informações.
"use strict";
const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");
const key = '<paste-your-key-here>';
const endpoint = '<paste-your-endpoint-here>';
//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 | Amostras adicionais | Pacote (PyPi) | Código-fonte da biblioteca
Use este início rápido para criar um aplicativo de detecção PII (Informações de Identificação Pessoal) com a biblioteca de clientes para Python. No exemplo a seguir, você criará um aplicativo Python que pode identificar informações confidenciais reconhecidas no texto.
Dica
Você pode usar o Language Studio para tentar realizar detecção de PII em documentos sem a necessidade de escrever código.
Pré-requisitos
- Assinatura do Azure – Criar uma gratuitamente
- Python 3.8 ou posterior
- Após obter sua assinatura do Azure, crie um recurso de Linguagem no portal do Azure para obter a chave e o ponto de extremidade. Após a implantação, selecione Ir para recurso.
- Você precisará da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Cole a chave e o ponto de extremidade no código abaixo mais adiante no guia de início rápido.
- Use o tipo de preço gratuito (
Free F0
) para experimentar o serviço e atualizar mais tarde para um nível pago para produção.
- Para usar o recurso Analisar, você precisará de um recurso de Linguagem de programação com o tipo de preço S (Standard).
Configurando
Instalar a biblioteca de clientes
Depois de instalar o Python, você pode instalar a biblioteca de clientes com:
pip install azure-ai-textanalytics==5.2.0
Exemplo de código
Crie um novo arquivo Python e copie o código abaixo. Lembre-se de substituir a variável key
pela chave do recurso e substituir a variável endpoint
pelo ponto de extremidade do recurso.
Importante
Vá para o portal do Azure. Se o recurso de Linguagem que você criou na seção Pré-requisitos tiver sido implantado com êxito, clique no botão Ir para o recurso em Próximas Etapas. Para encontrar a chave e o ponto de extremidade, acesse a página Chaves e Ponto de Extremidade do recurso em Gerenciamento de Recursos.
Importante
Lembre-se de remover a chave do seu código quando terminar e nunca poste-a publicamente. Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Confira o artigo sobre segurança dos serviços de IA do Azure para obter mais informações.
key = "paste-your-key-here"
endpoint = "paste-your-endpoint-here"
from azure.ai.textanalytics import TextAnalyticsClient
from azure.core.credentials import AzureKeyCredential
# Authenticate the client using your key and endpoint
def authenticate_client():
ta_credential = AzureKeyCredential(key)
text_analytics_client = TextAnalyticsClient(
endpoint=endpoint,
credential=ta_credential)
return text_analytics_client
client = authenticate_client()
# 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
Use este início rápido para enviar solicitações de detecção de PII (Informações Pessoais Identificáveis) usando a API REST. No exemplo a seguir, você usará o cURL para identificar informações confidenciais reconhecidas no texto.
Dica
Você pode usar o Language Studio para tentar realizar detecção de PII em documentos sem a necessidade de escrever código.
Pré-requisitos
- A versão atual do cURL.
- Após obter sua assinatura do Azure, crie um recurso de Linguagem no portal do Azure para obter a chave e o ponto de extremidade. Após a implantação, selecione Ir para recurso.
- Você precisará da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Cole a chave e o ponto de extremidade no código abaixo mais adiante no guia de início rápido.
- Use o tipo de preço gratuito (
Free F0
) para experimentar o serviço e atualizar mais tarde para um nível pago para produção.
Observação
- Os exemplos de BASH a seguir usam o caractere de continuação de linha
\
. Se o console ou o terminal usar um caractere de continuação de linha diferente, use aquele caractere. - Você pode encontrar exemplos específicos de cada linguagem de programação no GitHub.
- Acesse o portal do Azure e localize a chave e o ponto de extremidade do recurso de Linguagem criados nos pré-requisitos. Eles estarão localizados na página de chave e ponto de extremidade do recurso, em gerenciamento de recursos. Em seguida, substitua as cadeias de caracteres no código abaixo pela chave e o ponto de extremidade. Para chamar a API, você precisará das seguintes informações:
parâmetro | Descrição |
---|---|
-X POST <endpoint> |
Especifica o ponto de extremidade para acessar a API. |
-H Content-Type: application/json |
Tipo de conteúdo para enviar dados JSON. |
-H "Ocp-Apim-Subscription-Key:<key> |
Especifica a chave para acessar a API. |
-d <documents> |
JSON contendo os documentos que você deseja enviar. |
Os comandos cURL a seguir são executados por meio de um shell BASH. Edite esses comandos com o nome do recurso, a chave do recurso e os valores de JSON desejados.
Detecção de PII (informações de identificação pessoal)
- Copie o comando para um editor de texto.
- Faça as alterações a seguir no comando quando necessário:
- Substitua o valor
<your-language-resource-key>
pela chave. - Substitua a primeira parte da URL de solicitação
<your-language-resource-endpoint>
pela sua URL do ponto de extremidade.
- Substitua o valor
- Abra una janela de prompt de comando.
- Cole o comando do editor de texto na janela do prompt de comando e, em seguida, execute-o.
curl -i -X POST https://<your-language-resource-endpoint>/language/:analyze-text?api-version=2022-05-01 \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key:<your-language-resource-key>" \
-d \
'
{
"kind": "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"
}
]
}
}
'
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"
}
}
Limpar os recursos
Se quiser limpar e remover uma assinatura dos Serviços de IA do Azure, você poderá excluir o recurso ou grupo de recursos. Excluir o grupo de recursos também exclui todos os recursos associados a ele.