Inicio rápido: Detección de información de identificación personal (PII)

Documentación de referencia | Más ejemplos | Paquete (NuGet) | Código fuente de biblioteca

Use este inicio rápido para crear una aplicación de detección de información de identificación personal (PII) con la biblioteca cliente para .NET. En el siguiente ejemplo, creará una aplicación de C# que puede identificar información confidencial reconocida en el texto.

Requisitos previos

• suscripción a Azure: Crear una gratuita
• Una vez que tenga la suscripción de Azure, cree un recurso Foundry.
• El IDE de Visual Studio

Instalación

Creación de un recurso de Azure

Para usar el ejemplo de código siguiente, debe implementar un recurso de Azure. Este recurso contendrá una clave y un punto de conexión que use para autenticar las llamadas API que envíe a Azure Idioma.

1. Use el vínculo siguiente para crear un recurso de lenguaje mediante el portal de Azure. Debe iniciar sesión con la suscripción de Azure.

2. En la pantalla Seleccionar características adicionales, seleccione Continuar para crear el recurso.

   Una captura de pantalla que muestra las opciones de características adicionales en el portal de Azure.

3. En la pantalla Crear lenguaje, proporcione la siguiente información:

   Detalle	Descripción
   Subscription	La cuenta de suscripción a la que se asociará el recurso. Seleccione la suscripción Azure en el menú desplegable.
   Grupo de recursos	Un grupo de recursos es un contenedor que almacena los recursos que crea. Seleccione Crear nuevo para crear un nuevo grupo de recursos.
   Región	La ubicación del recurso de lenguaje. Las diferentes regiones pueden crear latencias, según la ubicación física en la que usted se encuentre, pero no tienen ningún impacto en la disponibilidad del tiempo de ejecución del recurso. En este inicio rápido, seleccione una región disponible cerca de usted o elija Este de EE. UU.
   Nombre	Nombre para el recurso de lenguaje. Este nombre también se usará para crear una dirección URL de punto de conexión que las aplicaciones usarán para enviar solicitudes de API.
   Nivel de precios	Plan de tarifa del recurso de idioma. Puede usar el nivel Gratis F0 para probar el servicio y actualizarlo más adelante a un nivel de pago cuando pase a producción.

   

4. Asegúrese de que la casilla Aviso de IA responsable esté activada.

5. En la parte inferior de la página, seleccione Revisar y crear.

6. En la pantalla que aparece, asegúrese de que se ha superado la validación y de que ha escrito la información correctamente. A continuación, seleccione Crear.

Consigue tu clave y punto de conexión

Ahora necesitará la clave y el punto de conexión del recurso para conectar la aplicación a la API. En una sección posterior de este mismo inicio rápido, pegará la clave y el punto de conexión en el código.

1. Después de que el recurso de Azure Language se implemente correctamente, haga clic en el botón Ir al recurso en Próximos pasos.

   

2. En la pantalla del recurso, seleccione Claves y punto de conexión en el panel izquierdo. Usará una de las claves y el punto de conexión en los pasos siguientes.

   

Creación de variables de entorno

La aplicación debe autenticarse para enviar solicitudes de API. En el caso de producción, use una forma segura de almacenar sus credenciales y acceder a ellas. En este ejemplo, escribirá las credenciales en variables de entorno del equipo local que ejecuta la aplicación.

Para establecer la variable de entorno para la clave del recurso de lenguaje, abra una ventana de consola y siga las instrucciones correspondientes a su sistema operativo y su entorno de desarrollo.

• Para establecer la variable de entorno LANGUAGE_KEY, reemplace your-key por una de las claves del recurso.
• Para establecer la variable de entorno LANGUAGE_ENDPOINT, reemplace your-endpoint por el punto de conexión del 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

Creación de una aplicación .NET Core

Con el IDE de Visual Studio, cree una aplicación de consola .NET Core. Este paso crea un proyecto de "Hola mundo" con un único archivo de código fuente de C#: program.cs.

Instale la biblioteca cliente haciendo clic con el botón derecho en la solución en el Explorador de soluciones y seleccionando Administrar paquetes NuGet. En el administrador de paquetes que se abre, seleccione Browse y busque Azure.AI.TextAnalytics. Seleccione la versión 5.2.0 e Instalar. También puede usar el Administrador de paquetes Console.

Ejemplo de código

Copie el código siguiente en el archivo program.cs y ejecute el 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 [email protected].";
        
            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();
        }

    }
}

Salida

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: [email protected], Category: Email, SubCategory: , Confidence score: 0.8

Documentación de referencia | Más ejemplos | Package (Maven) | Código fuente de la biblioteca

Use este inicio rápido para crear una aplicación de detección de información de identificación personal (PII) con la biblioteca cliente para Java. En el ejemplo siguiente, se crea una aplicación de Java que puede identificar información confidencial reconocida en texto.

Requisitos previos

• suscripción a Azure: Crear una gratuita
• Una vez que tenga la suscripción de Azure, cree un recurso Foundry.
• Java Kit de desarrollo (JDK) con la versión 8 o superior

Instalación

Creación de un recurso de Azure

Para usar el ejemplo de código siguiente, debe implementar un recurso de Azure. Este recurso contendrá una clave y un punto de conexión que use para autenticar las llamadas API que envíe a Azure Idioma.

1. Use el vínculo siguiente para crear un recurso de lenguaje mediante el portal de Azure. Debe iniciar sesión con la suscripción de Azure.

2. En la pantalla Seleccionar características adicionales, seleccione Continuar para crear el recurso.

   Una captura de pantalla que muestra las opciones de características adicionales en el portal de Azure.

3. En la pantalla Crear lenguaje, proporcione la siguiente información:

   Detalle	Descripción
   Subscription	La cuenta de suscripción a la que se asociará el recurso. Seleccione la suscripción Azure en el menú desplegable.
   Grupo de recursos	Un grupo de recursos es un contenedor que almacena los recursos que crea. Seleccione Crear nuevo para crear un nuevo grupo de recursos.
   Región	La ubicación del recurso de lenguaje. Las diferentes regiones pueden crear latencias, según la ubicación física en la que usted se encuentre, pero no tienen ningún impacto en la disponibilidad del tiempo de ejecución del recurso. En este inicio rápido, seleccione una región disponible cerca de usted o elija Este de EE. UU.
   Nombre	Nombre para el recurso de lenguaje. Este nombre también se usará para crear una dirección URL de punto de conexión que las aplicaciones usarán para enviar solicitudes de API.
   Nivel de precios	Plan de tarifa del recurso de idioma. Puede usar el nivel Gratis F0 para probar el servicio y actualizarlo más adelante a un nivel de pago cuando pase a producción.

   

4. Asegúrese de que la casilla Aviso de IA responsable esté activada.

5. En la parte inferior de la página, seleccione Revisar y crear.

6. En la pantalla que aparece, asegúrese de que se ha superado la validación y de que ha escrito la información correctamente. A continuación, seleccione Crear.

Consigue tu clave y punto de conexión

Ahora necesitará la clave y el punto de conexión del recurso para conectar la aplicación a la API. En una sección posterior de este mismo inicio rápido, pegará la clave y el punto de conexión en el código.

1. Después de que el recurso de Azure Language se implemente correctamente, haga clic en el botón Ir al recurso en Próximos pasos.

   

2. En la pantalla del recurso, seleccione Claves y punto de conexión en el panel izquierdo. Usará una de las claves y el punto de conexión en los pasos siguientes.

   

Creación de variables de entorno

La aplicación debe autenticarse para enviar solicitudes de API. En el caso de producción, use una forma segura de almacenar sus credenciales y acceder a ellas. En este ejemplo, escribirá las credenciales en variables de entorno del equipo local que ejecuta la aplicación.

Para establecer la variable de entorno para la clave del recurso de lenguaje, abra una ventana de consola y siga las instrucciones correspondientes a su sistema operativo y su entorno de desarrollo.

• Para establecer la variable de entorno LANGUAGE_KEY, reemplace your-key por una de las claves del recurso.
• Para establecer la variable de entorno LANGUAGE_ENDPOINT, reemplace your-endpoint por el punto de conexión del 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

Incorporación de la biblioteca cliente

Cree un proyecto de Maven en el entorno de desarrollo o IDE que prefiera. Luego, agregue la siguiente dependencia al archivo pom.xml del proyecto. La sintaxis de implementación de otras herramientas de compilación se puede encontrar en línea.

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

Ejemplo de código

Cree un archivo Java denominado Example.java. Abra el archivo y copie el código siguiente. Luego, ejecute el 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()));
    }
}

Salida

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

Documentación de referencia | Más ejemplos | Package (npm) | Código fuente de la biblioteca

Use este inicio rápido para crear una aplicación de detección de información de identificación personal (PII) con la biblioteca cliente de Node.js. En el siguiente ejemplo, creará una aplicación de JavaScript que puede identificar información confidencial reconocida en el texto.

Requisitos previos

• suscripción a Azure: Crear una gratuita
• Una vez que tenga la suscripción de Azure, cree un recurso Foundry.
• Node.js v14 LTS o posterior

Instalación

Creación de un recurso de Azure

Para usar el ejemplo de código siguiente, debe implementar un recurso de Azure. Este recurso contendrá una clave y un punto de conexión que use para autenticar las llamadas API que envíe a Azure Idioma.

1. Use el vínculo siguiente para crear un recurso de lenguaje mediante el portal de Azure. Debe iniciar sesión con la suscripción de Azure.

2. En la pantalla Seleccionar características adicionales, seleccione Continuar para crear el recurso.

   Una captura de pantalla que muestra las opciones de características adicionales en el portal de Azure.

3. En la pantalla Crear lenguaje, proporcione la siguiente información:

   Detalle	Descripción
   Subscription	La cuenta de suscripción a la que se asociará el recurso. Seleccione la suscripción Azure en el menú desplegable.
   Grupo de recursos	Un grupo de recursos es un contenedor que almacena los recursos que crea. Seleccione Crear nuevo para crear un nuevo grupo de recursos.
   Región	La ubicación del recurso de lenguaje. Las diferentes regiones pueden crear latencias, según la ubicación física en la que usted se encuentre, pero no tienen ningún impacto en la disponibilidad del tiempo de ejecución del recurso. En este inicio rápido, seleccione una región disponible cerca de usted o elija Este de EE. UU.
   Nombre	Nombre para el recurso de lenguaje. Este nombre también se usará para crear una dirección URL de punto de conexión que las aplicaciones usarán para enviar solicitudes de API.
   Nivel de precios	Plan de tarifa del recurso de idioma. Puede usar el nivel Gratis F0 para probar el servicio y actualizarlo más adelante a un nivel de pago cuando pase a producción.

   

4. Asegúrese de que la casilla Aviso de IA responsable esté activada.

5. En la parte inferior de la página, seleccione Revisar y crear.

6. En la pantalla que aparece, asegúrese de que se ha superado la validación y de que ha escrito la información correctamente. A continuación, seleccione Crear.

Consigue tu clave y punto de conexión

Ahora necesitará la clave y el punto de conexión del recurso para conectar la aplicación a la API. En una sección posterior de este mismo inicio rápido, pegará la clave y el punto de conexión en el código.

1. Después de que el recurso de Azure Language se implemente correctamente, haga clic en el botón Ir al recurso en Próximos pasos.

   

2. En la pantalla del recurso, seleccione Claves y punto de conexión en el panel izquierdo. Usará una de las claves y el punto de conexión en los pasos siguientes.

   

Creación de variables de entorno

La aplicación debe autenticarse para enviar solicitudes de API. En el caso de producción, use una forma segura de almacenar sus credenciales y acceder a ellas. En este ejemplo, escribirá las credenciales en variables de entorno del equipo local que ejecuta la aplicación.

Para establecer la variable de entorno para la clave del recurso de lenguaje, abra una ventana de consola y siga las instrucciones correspondientes a su sistema operativo y su entorno de desarrollo.

• Para establecer la variable de entorno LANGUAGE_KEY, reemplace your-key por una de las claves del recurso.
• Para establecer la variable de entorno LANGUAGE_ENDPOINT, reemplace your-endpoint por el punto de conexión del 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

Creación de una aplicación Node.js

En una ventana de la consola (como cmd, PowerShell o Bash), cree un directorio para la aplicación y vaya a él.

mkdir myapp

cd myapp

Ejecute el comando npm init para crear una aplicación de nodo con un archivo package.json.

npm init

Instalación de la biblioteca cliente

Instale el paquete npm:

npm install @azure/ai-text-analytics

Ejemplo de código

Abra el archivo y copie el ejemplo siguiente y ejecute el 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);
});

Salida

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

Documentación de referencia | Más ejemplos | Paquete (PyPi) | Código fuente de biblioteca

Use este inicio rápido para crear una aplicación de detección de información de identificación personal (PII) con la biblioteca cliente para Python. En el ejemplo siguiente, creará una aplicación de Python que podrá identificar información sensible reconocida en el texto.

Requisitos previos

• suscripción a Azure: Crear una gratuita
• Una vez que tenga la suscripción de Azure, cree un recurso Foundry.
• Python 3.8 o posterior

Instalación

Creación de un recurso de Azure

Para usar el ejemplo de código siguiente, debe implementar un recurso de Azure. Este recurso contendrá una clave y un punto de conexión que use para autenticar las llamadas API que envíe a Azure Idioma.

1. Use el vínculo siguiente para crear un recurso de lenguaje mediante el portal de Azure. Debe iniciar sesión con la suscripción de Azure.

2. En la pantalla Seleccionar características adicionales, seleccione Continuar para crear el recurso.

   Una captura de pantalla que muestra las opciones de características adicionales en el portal de Azure.

3. En la pantalla Crear lenguaje, proporcione la siguiente información:

   Detalle	Descripción
   Subscription	La cuenta de suscripción a la que se asociará el recurso. Seleccione la suscripción Azure en el menú desplegable.
   Grupo de recursos	Un grupo de recursos es un contenedor que almacena los recursos que crea. Seleccione Crear nuevo para crear un nuevo grupo de recursos.
   Región	La ubicación del recurso de lenguaje. Las diferentes regiones pueden crear latencias, según la ubicación física en la que usted se encuentre, pero no tienen ningún impacto en la disponibilidad del tiempo de ejecución del recurso. En este inicio rápido, seleccione una región disponible cerca de usted o elija Este de EE. UU.
   Nombre	Nombre para el recurso de lenguaje. Este nombre también se usará para crear una dirección URL de punto de conexión que las aplicaciones usarán para enviar solicitudes de API.
   Nivel de precios	Plan de tarifa del recurso de idioma. Puede usar el nivel Gratis F0 para probar el servicio y actualizarlo más adelante a un nivel de pago cuando pase a producción.

   

4. Asegúrese de que la casilla Aviso de IA responsable esté activada.

5. En la parte inferior de la página, seleccione Revisar y crear.

6. En la pantalla que aparece, asegúrese de que se ha superado la validación y de que ha escrito la información correctamente. A continuación, seleccione Crear.

Consigue tu clave y punto de conexión

Ahora necesitará la clave y el punto de conexión del recurso para conectar la aplicación a la API. En una sección posterior de este mismo inicio rápido, pegará la clave y el punto de conexión en el código.

1. Después de que el recurso de Azure Language se implemente correctamente, haga clic en el botón Ir al recurso en Próximos pasos.

   

2. En la pantalla del recurso, seleccione Claves y punto de conexión en el panel izquierdo. Usará una de las claves y el punto de conexión en los pasos siguientes.

   

Creación de variables de entorno

La aplicación debe autenticarse para enviar solicitudes de API. En el caso de producción, use una forma segura de almacenar sus credenciales y acceder a ellas. En este ejemplo, escribirá las credenciales en variables de entorno del equipo local que ejecuta la aplicación.

Para establecer la variable de entorno para la clave del recurso de lenguaje, abra una ventana de consola y siga las instrucciones correspondientes a su sistema operativo y su entorno de desarrollo.

• Para establecer la variable de entorno LANGUAGE_KEY, reemplace your-key por una de las claves del recurso.
• Para establecer la variable de entorno LANGUAGE_ENDPOINT, reemplace your-endpoint por el punto de conexión del 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

Instalación de la biblioteca cliente

Después de instalar Python, puede instalar la biblioteca cliente con:

pip install azure-ai-textanalytics==5.2.0

Ejemplo de código

Cree un nuevo archivo Python y copie el código siguiente. Luego, ejecute el 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)

Salida

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

Documentación de referencia

Use este inicio rápido para enviar solicitudes de detección de información de identificación personal (PII) mediante la API REST. En el ejemplo siguiente, usará cURL para identificar información confidencial reconocida en el texto.

Requisitos previos

• suscripción a Azure: Crear una gratuita
• Una vez que tenga la suscripción de Azure, cree un recurso Foundry.

Instalación

Creación de un recurso de Azure

Para usar el ejemplo de código siguiente, debe implementar un recurso de Azure. Este recurso contendrá una clave y un punto de conexión que use para autenticar las llamadas API que envíe a Azure Idioma.

1. Use el vínculo siguiente para crear un recurso de lenguaje mediante el portal de Azure. Debe iniciar sesión con la suscripción de Azure.

2. En la pantalla Seleccionar características adicionales, seleccione Continuar para crear el recurso.

   Una captura de pantalla que muestra las opciones de características adicionales en el portal de Azure.

3. En la pantalla Crear lenguaje, proporcione la siguiente información:

   Detalle	Descripción
   Subscription	La cuenta de suscripción a la que se asociará el recurso. Seleccione la suscripción Azure en el menú desplegable.
   Grupo de recursos	Un grupo de recursos es un contenedor que almacena los recursos que crea. Seleccione Crear nuevo para crear un nuevo grupo de recursos.
   Región	La ubicación del recurso de lenguaje. Las diferentes regiones pueden crear latencias, según la ubicación física en la que usted se encuentre, pero no tienen ningún impacto en la disponibilidad del tiempo de ejecución del recurso. En este inicio rápido, seleccione una región disponible cerca de usted o elija Este de EE. UU.
   Nombre	Nombre para el recurso de lenguaje. Este nombre también se usará para crear una dirección URL de punto de conexión que las aplicaciones usarán para enviar solicitudes de API.
   Nivel de precios	Plan de tarifa del recurso de idioma. Puede usar el nivel Gratis F0 para probar el servicio y actualizarlo más adelante a un nivel de pago cuando pase a producción.

   

4. Asegúrese de que la casilla Aviso de IA responsable esté activada.

5. En la parte inferior de la página, seleccione Revisar y crear.

6. En la pantalla que aparece, asegúrese de que se ha superado la validación y de que ha escrito la información correctamente. A continuación, seleccione Crear.

Consigue tu clave y punto de conexión

Ahora necesitará la clave y el punto de conexión del recurso para conectar la aplicación a la API. En una sección posterior de este mismo inicio rápido, pegará la clave y el punto de conexión en el código.

1. Después de que el recurso de Azure Language se implemente correctamente, haga clic en el botón Ir al recurso en Próximos pasos.

   

2. En la pantalla del recurso, seleccione Claves y punto de conexión en el panel izquierdo. Usará una de las claves y el punto de conexión en los pasos siguientes.

   

Creación de variables de entorno

La aplicación debe autenticarse para enviar solicitudes de API. En el caso de producción, use una forma segura de almacenar sus credenciales y acceder a ellas. En este ejemplo, escribirá las credenciales en variables de entorno del equipo local que ejecuta la aplicación.

Para establecer la variable de entorno para la clave del recurso de lenguaje, abra una ventana de consola y siga las instrucciones correspondientes a su sistema operativo y su entorno de desarrollo.

• Para establecer la variable de entorno LANGUAGE_KEY, reemplace your-key por una de las claves del recurso.
• Para establecer la variable de entorno LANGUAGE_ENDPOINT, reemplace your-endpoint por el punto de conexión del 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

Creación de un archivo JSON con el cuerpo de la solicitud de ejemplo

En un editor de código, cree un archivo denominado test_pii_payload.json y copie el JSON de ejemplo siguiente. Esta solicitud de ejemplo se enviará a la API en el paso siguiente.

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

Guarda test_pii_payload.json en alguna ubicación en tu ordenador. Por ejemplo, el escritorio.

Envío de una solicitud de API de detección de información de identificación personal (PII)

Use los comandos siguientes para enviar la solicitud de API mediante el programa que usa. Copie el comando en el terminal y ejecútelo.

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"

Respuesta 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": "[email protected]",
				"category": "Email",
				"offset": 53,
				"length": 19,
				"confidenceScore": 0.8
			}],
			"warnings": []
		}],
		"errors": [],
		"modelVersion": "2021-01-15"
	}
}

Requisitos previos

• Suscripción de Azure. Si no tiene ninguna, puede crearla gratis.
• Permisos necesarios. Asegúrese de que a la persona que crea la cuenta y el proyecto se le asigne el rol de Propietario de la cuenta de Foundry en el nivel de la suscripción. Como alternativa, tener el rol Colaborador o Colaborador de Cognitive Services en el ámbito de la suscripción también cumple este requisito. Para obtener más información, consulte Control de acceso basado en rol (RBAC).
• Recurso de Foundry. Cree un recurso foundry o consulte Configuración de un recurso foundry. Como alternativa, puede usar un recurso Language.
• Un proyecto de Foundry. Para obtener más información, consulte Crear un proyecto Foundry.

Requisitos de control de acceso basado en rol (RBAC)

Asigne los roles correctos a la entidad de seguridad de usuario y la identidad administrada del proyecto para acceder a las áreas de juegos de PII. Microsoft recomienda usar la autenticación Microsoft Entra ID, que exige restricciones basadas en roles. La autenticación basada en claves concede acceso completo sin comprobaciones de roles y debe evitarse en entornos de producción.

• Asigne los roles mínimos necesarios tanto a su entidad de seguridad de usuario como a la identidad administrada del proyecto para que puedan acceder a las características de Foundry.

• Verifique las asignaciones actuales con Comprobar el acceso de un usuario a un único recurso de Azure.