Hızlı Başlangıç: Kişisel Bilgileri Algılama (PII)

Başvuru belgeleri | Diğer örnekler | Paket (NuGet) | Kitaplık kaynak kodu

.NET için istemci kitaplığıyla Kişisel Bilgiler (PII) algılama uygulaması oluşturmak için bu hızlı başlangıcı kullanın. Aşağıdaki örnekte, metindeki tanınan hassas bilgileri tanımlayabilen bir C# uygulaması oluşturursunuz.

Önkoşullar

• Azure aboneliği - Ücretsiz olarak oluşturun
• Azure aboneliğinizi aldıktan sonra bir yapay zeka hizmetleri kaynağı oluşturun.
• Visual Studio IDE

Ayarlama

Ortam değişkenlerini oluşturma

API istekleri göndermek için uygulamanızın kimliği doğrulanmalıdır. Üretim için kimlik bilgilerinizi depolamanın ve bunlara erişmenin güvenli bir yolunu kullanın. Bu örnekte, kimlik bilgilerinizi uygulamayı çalıştıran yerel makinedeki ortam değişkenlerine yazacaksınız.

Dil kaynak anahtarınızın ortam değişkenini ayarlamak için bir konsol penceresi açın ve işletim sisteminiz ve geliştirme ortamınıza yönelik yönergeleri izleyin.

• Ortam değişkenini LANGUAGE_KEY ayarlamak için değerini kaynağınızın anahtarlarından biriyle değiştirin your-key .
• Ortam değişkenini LANGUAGE_ENDPOINT ayarlamak için değerini kaynağınızın uç noktasıyla değiştirin your-endpoint .

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

Yeni .NET Core uygulaması oluşturma

Visual Studio IDE’yi kullanarak yeni bir .NET Core konsol uygulaması oluşturun. Bu, tek bir C# kaynak dosyasıyla bir "Merhaba Dünya" projesi oluşturur: program.cs.

Çözüm Gezgini’nde çözüme sağ tıklayarak ve NuGet paketlerini yönet seçeneğini belirleyerek istemci kitaplığını yükleyin. Açılan paket yöneticisinde Gözat'ı seçin ve öğesini arayınAzure.AI.TextAnalytics. Sürüm olarak 5.2.0 seçin ve Yükle seçeneğini belirleyin. Paket Yöneticisi Konsolu’nu da kullanabilirsiniz.

Kod örneği

Aşağıdaki kodu program.cs dosyanıza kopyalayın ve kodu çalıştırın.

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

    }
}

Çıktı

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

Başvuru belgeleri | Diğer örnekler | Paket (Maven) | Kitaplık kaynak kodu

Java için istemci kitaplığıyla Kişisel Bilgiler (PII) algılama uygulaması oluşturmak için bu hızlı başlangıcı kullanın. Aşağıdaki örnekte, metindeki tanınan hassas bilgileri tanımlayabilen bir Java uygulaması oluşturursunuz.

Önkoşullar

• Azure aboneliği - Ücretsiz olarak oluşturun
• Azure aboneliğinizi aldıktan sonra bir yapay zeka hizmetleri kaynağı oluşturun.
• Java Geliştirme Seti (JDK) sürüm 8 veya üstü

Ayarlama

Ortam değişkenlerini oluşturma

API istekleri göndermek için uygulamanızın kimliği doğrulanmalıdır. Üretim için kimlik bilgilerinizi depolamanın ve bunlara erişmenin güvenli bir yolunu kullanın. Bu örnekte, kimlik bilgilerinizi uygulamayı çalıştıran yerel makinedeki ortam değişkenlerine yazacaksınız.

Dil kaynak anahtarınızın ortam değişkenini ayarlamak için bir konsol penceresi açın ve işletim sisteminiz ve geliştirme ortamınıza yönelik yönergeleri izleyin.

• Ortam değişkenini LANGUAGE_KEY ayarlamak için değerini kaynağınızın anahtarlarından biriyle değiştirin your-key .
• Ortam değişkenini LANGUAGE_ENDPOINT ayarlamak için değerini kaynağınızın uç noktasıyla değiştirin your-endpoint .

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

İstemci kitaplığını ekleme

Tercih ettiğiniz IDE veya geliştirme ortamında bir Maven projesi oluşturun. Ardından aşağıdaki bağımlılığı projenizin pom.xml dosyasına ekleyin. Diğer derleme araçlarına yönelik uygulama söz dizimini çevrimiçi olarak bulabilirsiniz.

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

Kod örneği

Example.java adlı bir Java dosyası oluşturun. Dosyayı açın ve aşağıdaki kodu kopyalayın. Sonra kodu çalıştırın.

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

Çıktı

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

Başvuru belgeleri | Diğer örnekler | Paket (npm) | Kitaplık kaynak kodu

Node.js için istemci kitaplığıyla Kişisel Bilgiler (PII) algılama uygulaması oluşturmak için bu hızlı başlangıcı kullanın. Aşağıdaki örnekte, metindeki tanınan hassas bilgileri tanımlayabilen bir JavaScript uygulaması oluşturursunuz.

Önkoşullar

• Azure aboneliği - Ücretsiz olarak oluşturun
• Azure aboneliğinizi aldıktan sonra bir yapay zeka hizmetleri kaynağı oluşturun.
• Node.js v14 LTS veya üzeri

Ayarlama

Ortam değişkenlerini oluşturma

API istekleri göndermek için uygulamanızın kimliği doğrulanmalıdır. Üretim için kimlik bilgilerinizi depolamanın ve bunlara erişmenin güvenli bir yolunu kullanın. Bu örnekte, kimlik bilgilerinizi uygulamayı çalıştıran yerel makinedeki ortam değişkenlerine yazacaksınız.

Dil kaynak anahtarınızın ortam değişkenini ayarlamak için bir konsol penceresi açın ve işletim sisteminiz ve geliştirme ortamınıza yönelik yönergeleri izleyin.

• Ortam değişkenini LANGUAGE_KEY ayarlamak için değerini kaynağınızın anahtarlarından biriyle değiştirin your-key .
• Ortam değişkenini LANGUAGE_ENDPOINT ayarlamak için değerini kaynağınızın uç noktasıyla değiştirin your-endpoint .

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

Yeni bir Node.js uygulaması oluşturma

Konsol penceresinde (cmd, PowerShell veya Bash gibi), uygulamanız için yeni bir dizin oluşturun ve bu dizine gidin.

mkdir myapp 

cd myapp

Bir package.json dosyası ile bir düğüm uygulaması oluşturmak için npm init komutunu çalıştırın.

npm init

İstemci kitaplığını yükleme

npm paketini yükleyin:

npm install @azure/ai-text-analytics

Kod örneği

Dosyayı açın ve aşağıdaki kodu kopyalayın. Sonra kodu çalıştırın.

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

Çıktı

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

Başvuru belgeleri | Diğer örnekler | Paket (PyPi) | Kitaplık kaynak kodu

Python için istemci kitaplığıyla Kişisel Bilgiler (PII) algılama uygulaması oluşturmak için bu hızlı başlangıcı kullanın. Aşağıdaki örnekte, metindeki tanınan hassas bilgileri tanımlayabilen bir Python uygulaması oluşturacaksınız.

Önkoşullar

• Azure aboneliği - Ücretsiz olarak oluşturun
• Azure aboneliğinizi aldıktan sonra bir yapay zeka hizmetleri kaynağı oluşturun.
• Python 3.8 veya üzeri

Ayarlama

Ortam değişkenlerini oluşturma

API istekleri göndermek için uygulamanızın kimliği doğrulanmalıdır. Üretim için kimlik bilgilerinizi depolamanın ve bunlara erişmenin güvenli bir yolunu kullanın. Bu örnekte, kimlik bilgilerinizi uygulamayı çalıştıran yerel makinedeki ortam değişkenlerine yazacaksınız.

Dil kaynak anahtarınızın ortam değişkenini ayarlamak için bir konsol penceresi açın ve işletim sisteminiz ve geliştirme ortamınıza yönelik yönergeleri izleyin.

• Ortam değişkenini LANGUAGE_KEY ayarlamak için değerini kaynağınızın anahtarlarından biriyle değiştirin your-key .
• Ortam değişkenini LANGUAGE_ENDPOINT ayarlamak için değerini kaynağınızın uç noktasıyla değiştirin your-endpoint .

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

İstemci kitaplığını yükleme

Python yükledikten sonra şunları kullanarak istemci kitaplığını yükleyebilirsiniz:

pip install azure-ai-textanalytics==5.2.0

Kod örneği

Yeni bir Python dosyası oluşturun ve aşağıdaki kodu kopyalayın. Sonra kodu çalıştırın.

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

Çıktı

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

Başvuru belgeleri

REST API kullanarak Kişisel Bilgiler (PII) algılama istekleri göndermek için bu hızlı başlangıcı kullanın. Aşağıdaki örnekte, metindeki tanınan hassas bilgileri tanımlamak için cURL kullanacaksınız.

Önkoşullar

• Azure aboneliği - Ücretsiz olarak oluşturun
• Azure aboneliğinizi aldıktan sonra bir yapay zeka hizmetleri kaynağı oluşturun.

Ayarlama

Ortam değişkenlerini oluşturma

API istekleri göndermek için uygulamanızın kimliği doğrulanmalıdır. Üretim için kimlik bilgilerinizi depolamanın ve bunlara erişmenin güvenli bir yolunu kullanın. Bu örnekte, kimlik bilgilerinizi uygulamayı çalıştıran yerel makinedeki ortam değişkenlerine yazacaksınız.

Dil kaynak anahtarınızın ortam değişkenini ayarlamak için bir konsol penceresi açın ve işletim sisteminiz ve geliştirme ortamınıza yönelik yönergeleri izleyin.

• Ortam değişkenini LANGUAGE_KEY ayarlamak için değerini kaynağınızın anahtarlarından biriyle değiştirin your-key .
• Ortam değişkenini LANGUAGE_ENDPOINT ayarlamak için değerini kaynağınızın uç noktasıyla değiştirin your-endpoint .

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

Örnek istek gövdesiyle bir JSON dosyası oluşturma

Kod düzenleyicisinde adlı test_pii_payload.json yeni bir dosya oluşturun ve aşağıdaki JSON örneğini kopyalayın. Bu örnek istek, sonraki adımda API'ye gönderilecektir.

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

Bilgisayarınızda bir yere kaydedin test_pii_payload.json . Örneğin, masaüstünüz.

Kişisel olarak tanımlayıcı bilgiler (PII) algılama API'si isteği gönderme

Kullandığınız programı kullanarak API isteği göndermek için aşağıdaki komutları kullanın. Komutunu terminalinize kopyalayın ve çalıştırın.

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"

JSON yanıtı

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