Início Rápido: Detetar informação pessoal identificável (PII)

Documentação de referência | Mais exemplos | Package (NuGet) | código-fonte da biblioteca

Use este início rápido para criar uma aplicação de deteção de Informação Pessoalmente Identificável (PII) com a biblioteca cliente para .NET. No exemplo seguinte, cria-se uma aplicação C# que pode identificar informações sensíveis reconhecidas em texto.

Pré-requisitos

• Azure subscrição - Criar uma gratuitamente
• Depois de ter a sua subscrição do Azure, crie um recurso na Foundry.
• A IDE do Visual Studio

Preparação

Criar um recurso Azure

Para usar o exemplo de código abaixo, precisa de implementar um recurso do Azure. Este recurso conterá uma chave e um endpoint que usas para autenticar as chamadas de API que envias para o Azure Language.

1. Use o link seguinte para criar um recurso linguístico usando o portal Azure. Precisa de iniciar sessão usando a sua subscrição do Azure.

2. No ecrã de Selecionar funcionalidades adicionais que aparece, selecione Continuar para criar o seu recurso.

   

3. No ecrã de Criar linguagem , forneça a seguinte informação:

   Detalhe	Descrição
   Subscrição	A conta de subscrição à qual o seu recurso estará associado. Selecione a sua subscrição do Azure no menu suspenso.
   Grupo de recursos	Um grupo de recursos é um contentor que armazena os recursos que cria. Selecione Criar novo para criar um novo grupo de recursos.
   Região	A localização do seu recurso linguístico. Diferentes regiões podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade em tempo de execução do seu recurso. Para este quickstart, selecione uma região disponível perto de si, ou escolha Leste dos EUA.
   Nome	O nome do teu recurso de Língua. Este nome também será usado para criar uma URL de endpoint que as suas aplicações usarão para enviar pedidos de API.
   Escalão de preços	O escalão de preços para o seu recurso de Língua. Podes usar o nível Free F0 para experimentar o serviço e depois fazer um upgrade para um tier pago para produção.

   

4. Certifique-se de que a caixa de Aviso de IA Responsável está assinalada.

5. Selecione Rever + Criar no fundo da página.

6. No ecrã que aparece, certifique-se de que a validação passou e que introduziu corretamente a sua informação. Depois seleciona Criar.

Obtenha a sua chave e endpoint

De seguida, vais precisar da chave e do endpoint do recurso para ligar a tua aplicação à API. Vais colar a tua chave e endpoint no código mais tarde no quickstart.

1. Depois de o recurso de linguagem do Azure ser implementado com sucesso, clique no botão Ir para o Recurso abaixo de Próximos Passos.

   

2. No ecrã do teu recurso, seleciona Keys e endpoint no painel esquerdo. Vais usar uma das tuas chaves e o teu endpoint nos passos abaixo.

   

Criar variáveis de ambiente

A sua aplicação deve ser autenticada para enviar pedidos de API. Para produção, utilize uma forma segura de armazenar e aceder às suas credenciais. Neste exemplo, irá escrever as suas credenciais para variáveis de ambiente na máquina local que executa a aplicação.

Para definir a variável de ambiente para a chave de recurso da sua linguagem, abra uma janela de consola e siga as instruções do seu sistema operativo e ambiente de desenvolvimento.

• Para definir a LANGUAGE_KEY variável de ambiente, substitui your-key por uma das chaves do teu recurso.
• Para definir a LANGUAGE_ENDPOINT variável de ambiente, substitua your-endpoint pelo endpoint do seu recurso.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

Criar uma nova aplicação .NET Core

Usando o Visual Studio IDE, crie uma nova aplicação de consola .NET Core. Este passo cria um projeto "Hello World" com um único ficheiro fonte em C#: program.cs.

Instale a biblioteca cliente clicando com o botão direito na solução no Explorador de Soluções e selecionando Gerir Pacotes NuGet. No gestor de pacotes que se abre, selecione Browse e procure por Azure.AI.TextAnalytics. Selecione a versão 5.2.0e depois Instalar. Também podes usar a consola Gestor de Pacotes .

Exemplo de código

Copie o código seguinte para o seu ficheiro 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");

        // 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)
        {
            if (string.IsNullOrWhiteSpace(languageKey) || string.IsNullOrWhiteSpace(languageEndpoint))
            {
                Console.WriteLine("Missing LANGUAGE_KEY or LANGUAGE_ENDPOINT environment variables.");
                return;
            }

            var endpoint = new Uri(languageEndpoint);
            var credentials = new AzureKeyCredential(languageKey);
            var client = new TextAnalyticsClient(endpoint, credentials);
            RecognizePIIExample(client);

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

    }
}

Produção

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 | Package (Maven) | código-fonte da biblioteca

Use este início rápido para criar uma aplicação de deteção de Informação Pessoal Identificável (PII) com a biblioteca de cliente para Java. No exemplo seguinte, cria uma aplicação Java que pode identificar informação sensível reconhecida no texto.

Pré-requisitos

• Azure subscrição - Criar uma gratuitamente
• Depois de ter a sua subscrição do Azure, crie um recurso na Foundry.
• Kit de Desenvolvimento Java (JDK) com versão 8 ou superior

Preparação

Criar um recurso Azure

Para usar o exemplo de código abaixo, precisa de implementar um recurso do Azure. Este recurso conterá uma chave e um endpoint que usas para autenticar as chamadas de API que envias para o Azure Language.

1. Use o link seguinte para criar um recurso linguístico usando o portal Azure. Precisa de iniciar sessão usando a sua subscrição do Azure.

2. No ecrã de Selecionar funcionalidades adicionais que aparece, selecione Continuar para criar o seu recurso.

   

3. No ecrã de Criar linguagem , forneça a seguinte informação:

   Detalhe	Descrição
   Subscrição	A conta de subscrição à qual o seu recurso estará associado. Selecione a sua subscrição do Azure no menu suspenso.
   Grupo de recursos	Um grupo de recursos é um contentor que armazena os recursos que cria. Selecione Criar novo para criar um novo grupo de recursos.
   Região	A localização do seu recurso linguístico. Diferentes regiões podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade em tempo de execução do seu recurso. Para este quickstart, selecione uma região disponível perto de si, ou escolha Leste dos EUA.
   Nome	O nome do teu recurso de Língua. Este nome também será usado para criar uma URL de endpoint que as suas aplicações usarão para enviar pedidos de API.
   Escalão de preços	O escalão de preços para o seu recurso de Língua. Podes usar o nível Free F0 para experimentar o serviço e depois fazer um upgrade para um tier pago para produção.

   

4. Certifique-se de que a caixa de Aviso de IA Responsável está assinalada.

5. Selecione Rever + Criar no fundo da página.

6. No ecrã que aparece, certifique-se de que a validação passou e que introduziu corretamente a sua informação. Depois seleciona Criar.

Obtenha a sua chave e endpoint

De seguida, vais precisar da chave e do endpoint do recurso para ligar a tua aplicação à API. Vais colar a tua chave e endpoint no código mais tarde no quickstart.

1. Depois de o recurso de linguagem do Azure ser implementado com sucesso, clique no botão Ir para o Recurso abaixo de Próximos Passos.

   

2. No ecrã do teu recurso, seleciona Keys e endpoint no painel esquerdo. Vais usar uma das tuas chaves e o teu endpoint nos passos abaixo.

   

Criar variáveis de ambiente

A sua aplicação deve ser autenticada para enviar pedidos de API. Para produção, utilize uma forma segura de armazenar e aceder às suas credenciais. Neste exemplo, irá escrever as suas credenciais para variáveis de ambiente na máquina local que executa a aplicação.

Para definir a variável de ambiente para a chave de recurso da sua linguagem, abra uma janela de consola e siga as instruções do seu sistema operativo e ambiente de desenvolvimento.

• Para definir a LANGUAGE_KEY variável de ambiente, substitui your-key por uma das chaves do teu recurso.
• Para definir a LANGUAGE_ENDPOINT variável de ambiente, substitua your-endpoint pelo endpoint do seu recurso.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

Adicionar a biblioteca cliente

Crie um projeto Maven no seu IDE ou ambiente de desenvolvimento preferido. Depois adiciona a seguinte dependência ao ficheiropom.xml do teu projeto. Podes encontrar a sintaxe de implementação de outras ferramentas de construçã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 chamado Example.java. Abra o ficheiro e copie o código seguinte. Depois executa 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) {
        if (languageKey == null || languageKey.isBlank() || languageEndpoint == null || languageEndpoint.isBlank()) {
            throw new IllegalArgumentException("Missing LANGUAGE_KEY or LANGUAGE_ENDPOINT environment variables");
        }
        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()));
    }
}

Produção

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 | Package (npm) | Código-fonte da biblioteca

Use este guia de início rápido para criar uma aplicação de deteção de Informação Pessoalmente Identificável (PII) com a biblioteca cliente para Node.js. No exemplo seguinte, cria uma aplicação JavaScript que pode identificar informações sensíveis reconhecidas em texto.

Pré-requisitos

• Azure subscrição - Criar uma gratuitamente
• Depois de ter a sua subscrição do Azure, crie um recurso na Foundry.
• Node.js v14 LTS ou posterior

Preparação

Criar um recurso Azure

Para usar o exemplo de código abaixo, precisa de implementar um recurso do Azure. Este recurso conterá uma chave e um endpoint que usas para autenticar as chamadas de API que envias para o Azure Language.

1. Use o link seguinte para criar um recurso linguístico usando o portal Azure. Precisa de iniciar sessão usando a sua subscrição do Azure.

2. No ecrã de Selecionar funcionalidades adicionais que aparece, selecione Continuar para criar o seu recurso.

   

3. No ecrã de Criar linguagem , forneça a seguinte informação:

   Detalhe	Descrição
   Subscrição	A conta de subscrição à qual o seu recurso estará associado. Selecione a sua subscrição do Azure no menu suspenso.
   Grupo de recursos	Um grupo de recursos é um contentor que armazena os recursos que cria. Selecione Criar novo para criar um novo grupo de recursos.
   Região	A localização do seu recurso linguístico. Diferentes regiões podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade em tempo de execução do seu recurso. Para este quickstart, selecione uma região disponível perto de si, ou escolha Leste dos EUA.
   Nome	O nome do teu recurso de Língua. Este nome também será usado para criar uma URL de endpoint que as suas aplicações usarão para enviar pedidos de API.
   Escalão de preços	O escalão de preços para o seu recurso de Língua. Podes usar o nível Free F0 para experimentar o serviço e depois fazer um upgrade para um tier pago para produção.

   

4. Certifique-se de que a caixa de Aviso de IA Responsável está assinalada.

5. Selecione Rever + Criar no fundo da página.

6. No ecrã que aparece, certifique-se de que a validação passou e que introduziu corretamente a sua informação. Depois seleciona Criar.

Obtenha a sua chave e endpoint

De seguida, vais precisar da chave e do endpoint do recurso para ligar a tua aplicação à API. Vais colar a tua chave e endpoint no código mais tarde no quickstart.

1. Depois de o recurso de linguagem do Azure ser implementado com sucesso, clique no botão Ir para o Recurso abaixo de Próximos Passos.

   

2. No ecrã do teu recurso, seleciona Keys e endpoint no painel esquerdo. Vais usar uma das tuas chaves e o teu endpoint nos passos abaixo.

   

Criar variáveis de ambiente

A sua aplicação deve ser autenticada para enviar pedidos de API. Para produção, utilize uma forma segura de armazenar e aceder às suas credenciais. Neste exemplo, irá escrever as suas credenciais para variáveis de ambiente na máquina local que executa a aplicação.

Para definir a variável de ambiente para a chave de recurso da sua linguagem, abra uma janela de consola e siga as instruções do seu sistema operativo e ambiente de desenvolvimento.

• Para definir a LANGUAGE_KEY variável de ambiente, substitui your-key por uma das chaves do teu recurso.
• Para definir a LANGUAGE_ENDPOINT variável de ambiente, substitua your-endpoint pelo endpoint do seu recurso.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

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 até lá.

mkdir myapp

cd myapp

Execute o comando npm init para criar uma aplicação Node.js com um ficheiro package.json.

npm init

Instalar a biblioteca cliente

Instale o pacote npm:

npm install @azure/ai-text-analytics

Exemplo de código

Abra o ficheiro, copie o exemplo seguinte e 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;

if (!key || !endpoint) {
  throw new Error("Missing LANGUAGE_KEY or LANGUAGE_ENDPOINT environment variables.");
}

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 results = await client.recognizePiiEntities(documents, "en");

    for (const result of results) {
      if (result.error) {
        console.error("Encountered an error:", result.error);
        continue;
      }

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

Produção

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

Documentação de referência | Mais exemplos | Package (PyPi) | código-fonte da biblioteca

Utilize este guia de início rápido para criar uma aplicação de deteção de Informação de Identificação Pessoal (PII) com a biblioteca cliente para Python. No exemplo seguinte, irá criar uma aplicação Python que pode identificar informação sensível reconhecida no texto.

Pré-requisitos

• Azure subscrição - Criar uma gratuitamente
• Depois de ter a sua subscrição do Azure, crie um recurso na Foundry.
• Python 3,8 ou posterior

Preparação

Criar um recurso Azure

Para usar o exemplo de código abaixo, precisa de implementar um recurso do Azure. Este recurso conterá uma chave e um endpoint que usas para autenticar as chamadas de API que envias para o Azure Language.

1. Use o link seguinte para criar um recurso linguístico usando o portal Azure. Precisa de iniciar sessão usando a sua subscrição do Azure.

2. No ecrã de Selecionar funcionalidades adicionais que aparece, selecione Continuar para criar o seu recurso.

   

3. No ecrã de Criar linguagem , forneça a seguinte informação:

   Detalhe	Descrição
   Subscrição	A conta de subscrição à qual o seu recurso estará associado. Selecione a sua subscrição do Azure no menu suspenso.
   Grupo de recursos	Um grupo de recursos é um contentor que armazena os recursos que cria. Selecione Criar novo para criar um novo grupo de recursos.
   Região	A localização do seu recurso linguístico. Diferentes regiões podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade em tempo de execução do seu recurso. Para este quickstart, selecione uma região disponível perto de si, ou escolha Leste dos EUA.
   Nome	O nome do teu recurso de Língua. Este nome também será usado para criar uma URL de endpoint que as suas aplicações usarão para enviar pedidos de API.
   Escalão de preços	O escalão de preços para o seu recurso de Língua. Podes usar o nível Free F0 para experimentar o serviço e depois fazer um upgrade para um tier pago para produção.

   

4. Certifique-se de que a caixa de Aviso de IA Responsável está assinalada.

5. Selecione Rever + Criar no fundo da página.

6. No ecrã que aparece, certifique-se de que a validação passou e que introduziu corretamente a sua informação. Depois seleciona Criar.

Obtenha a sua chave e endpoint

De seguida, vais precisar da chave e do endpoint do recurso para ligar a tua aplicação à API. Vais colar a tua chave e endpoint no código mais tarde no quickstart.

1. Depois de o recurso de linguagem do Azure ser implementado com sucesso, clique no botão Ir para o Recurso abaixo de Próximos Passos.

   

2. No ecrã do teu recurso, seleciona Keys e endpoint no painel esquerdo. Vais usar uma das tuas chaves e o teu endpoint nos passos abaixo.

   

Criar variáveis de ambiente

A sua aplicação deve ser autenticada para enviar pedidos de API. Para produção, utilize uma forma segura de armazenar e aceder às suas credenciais. Neste exemplo, irá escrever as suas credenciais para variáveis de ambiente na máquina local que executa a aplicação.

Para definir a variável de ambiente para a chave de recurso da sua linguagem, abra uma janela de consola e siga as instruções do seu sistema operativo e ambiente de desenvolvimento.

• Para definir a LANGUAGE_KEY variável de ambiente, substitui your-key por uma das chaves do teu recurso.
• Para definir a LANGUAGE_ENDPOINT variável de ambiente, substitua your-endpoint pelo endpoint do seu recurso.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

Instalar a biblioteca cliente

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

pip install azure-ai-textanalytics==5.2.0

Exemplo de código

Crie um novo ficheiro Python e copie o código abaixo. Depois executa o código.

import os

from azure.ai.textanalytics import TextAnalyticsClient
from azure.core.credentials import AzureKeyCredential

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

if not language_key or not language_endpoint:
        raise ValueError("Missing LANGUAGE_KEY or LANGUAGE_ENDPOINT environment variables")

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

Produção

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 pedidos de deteção de Informação Pessoal Identificável (PII) usando a API REST. No exemplo seguinte, usará cURL para identificar informações sensíveis reconhecidas no texto.

Pré-requisitos

• Azure subscrição - Criar uma gratuitamente
• Depois de ter a sua subscrição do Azure, crie um recurso na Foundry.

Preparação

Criar um recurso Azure

Para usar o exemplo de código abaixo, precisa de implementar um recurso do Azure. Este recurso conterá uma chave e um endpoint que usas para autenticar as chamadas de API que envias para o Azure Language.

1. Use o link seguinte para criar um recurso linguístico usando o portal Azure. Precisa de iniciar sessão usando a sua subscrição do Azure.

2. No ecrã de Selecionar funcionalidades adicionais que aparece, selecione Continuar para criar o seu recurso.

   

3. No ecrã de Criar linguagem , forneça a seguinte informação:

   Detalhe	Descrição
   Subscrição	A conta de subscrição à qual o seu recurso estará associado. Selecione a sua subscrição do Azure no menu suspenso.
   Grupo de recursos	Um grupo de recursos é um contentor que armazena os recursos que cria. Selecione Criar novo para criar um novo grupo de recursos.
   Região	A localização do seu recurso linguístico. Diferentes regiões podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade em tempo de execução do seu recurso. Para este quickstart, selecione uma região disponível perto de si, ou escolha Leste dos EUA.
   Nome	O nome do teu recurso de Língua. Este nome também será usado para criar uma URL de endpoint que as suas aplicações usarão para enviar pedidos de API.
   Escalão de preços	O escalão de preços para o seu recurso de Língua. Podes usar o nível Free F0 para experimentar o serviço e depois fazer um upgrade para um tier pago para produção.

   

4. Certifique-se de que a caixa de Aviso de IA Responsável está assinalada.

5. Selecione Rever + Criar no fundo da página.

6. No ecrã que aparece, certifique-se de que a validação passou e que introduziu corretamente a sua informação. Depois seleciona Criar.

Obtenha a sua chave e endpoint

De seguida, vais precisar da chave e do endpoint do recurso para ligar a tua aplicação à API. Vais colar a tua chave e endpoint no código mais tarde no quickstart.

1. Depois de o recurso de linguagem do Azure ser implementado com sucesso, clique no botão Ir para o Recurso abaixo de Próximos Passos.

   

2. No ecrã do teu recurso, seleciona Keys e endpoint no painel esquerdo. Vais usar uma das tuas chaves e o teu endpoint nos passos abaixo.

   

Criar variáveis de ambiente

A sua aplicação deve ser autenticada para enviar pedidos de API. Para produção, utilize uma forma segura de armazenar e aceder às suas credenciais. Neste exemplo, irá escrever as suas credenciais para variáveis de ambiente na máquina local que executa a aplicação.

Para definir a variável de ambiente para a chave de recurso da sua linguagem, abra uma janela de consola e siga as instruções do seu sistema operativo e ambiente de desenvolvimento.

• Para definir a LANGUAGE_KEY variável de ambiente, substitui your-key por uma das chaves do teu recurso.
• Para definir a LANGUAGE_ENDPOINT variável de ambiente, substitua your-endpoint pelo endpoint do seu recurso.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

Crie um ficheiro JSON com o corpo do pedido de exemplo

Num editor de código, crie um novo ficheiro com o nome test_pii_payload.json e copie o seguinte exemplo JSON. Este pedido de exemplo será enviado para a API na etapa seguinte.

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

Guarda test_pii_payload.json algures no teu computador. Por exemplo, o teu ambiente de trabalho.

Enviar um pedido de API de deteção de informação pessoal identificável (PII)

Use os seguintes comandos para enviar o pedido de API usando o programa que está a usar. Copia o comando para o teu terminal e executa-o.

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"

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"

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 "@/home/mydir/test_pii_payload.json"

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 "@/home/mydir/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"
    }
}

Pré-requisitos

• Subscrição do Azure. Se não tiveres um, podes criar um gratuitamente.
• Permissões necessárias. Certifique-se de que à pessoa que cria a conta e o projeto lhe é atribuída a função de Proprietário da Conta Foundry ao nível da subscrição. Alternativamente, ter o papel de Contribuidor ou Contribuidor de Serviços Cognitivos no âmbito da subscrição também cumpre este requisito. Para mais informações, consulte Controlo de acesso baseado em funções (RBAC).
• Recurso da fundição. Crie um recurso Foundry ou consulte Configurar um recurso Foundry. Em alternativa, pode usar um recurso Language.
• Um projeto da Foundry. Para mais informações, consulte o projeto Criar uma Fundição.

Requisitos de controlo de acesso baseado em funções (RBAC)

Atribua os papéis corretos ao teu utilizador principal e à identidade gerida do projeto para aceder aos playgrounds de PII. A Microsoft recomenda a utilização da autenticação Microsoft Entra ID, que impõe restrições baseadas em funções. A autenticação baseada em chaves concede acesso total sem verificações de função e deve ser evitada em ambientes de produção.

• Atribua os papéis mínimos exigidos tanto à tua identidade de utilizador principal como à de gestão de projeto, para que possam aceder às funcionalidades do Foundry.

• Verifique as atribuições atuais usando Verifique o acesso de um utilizador a um único recurso Azure.