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

  • Makale

Not

Bu hızlı başlangıç yalnızca belgelerde PII algılamayı kapsar. Konuşmalarda PII algılama hakkında daha fazla bilgi edinmek için bkz . Konuşmalarda PII'yi algılama ve yeniden dağıtma.

Başvuru belgeleri | Ek ö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şturacaksınız.

İpucu

Kod yazmaya gerek kalmadan belgelerde PII algılamayı denemek için Language Studio'yu kullanabilirsiniz.

Önkoşullar

  • Azure aboneliği - Ücretsiz olarak oluşturun
  • Visual Studio IDE
  • Azure aboneliğinizi aldıktan sonra anahtarınızı ve uç noktanızı almak için Azure portalında bir Dil kaynağı oluşturun. Dağıtıldıktan sonra Kaynağa git'i seçin.
    • Uygulamanızı API'ye bağlamak için oluşturduğunuz kaynaktan anahtara ve uç noktaya ihtiyacınız olacaktır. Anahtarınızı ve uç noktanızı hızlı başlangıcın ilerleyen bölümlerinde aşağıdaki koda yapıştıracaksınız.
    • Hizmeti denemek ve daha sonra üretim için ücretli bir katmana yükseltmek için ücretsiz fiyatlandırma katmanını (Free F0) kullanabilirsiniz.
  • Çözümle özelliğini kullanmak için standart (S) fiyatlandırma katmanına sahip bir Dil kaynağı gerekir.

Ayarlama

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 (program.cs) “Merhaba Dünya” adında bir proje oluşturur.

Çö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. değişkeni kaynağınızın anahtarıyla değiştirmeyi key ve değişkeni kaynağınızın uç noktasıyla değiştirmeyi endpoint unutmayın.

Önemli

Azure portalına gidin. Önkoşullar bölümünde oluşturduğunuz Dil kaynağı başarıyla dağıtıldıysa, Sonraki Adımlar'ın altındaki Kaynağa Git düğmesine tıklayın. Kaynağınızın Anahtarlar ve Uç Nokta sayfasına gidip Kaynak Yönetimi'nin altında anahtarınızı ve uç noktanızı bulabilirsiniz.

Önemli

İşiniz bittiğinde anahtarı kodunuzdan kaldırmayı unutmayın ve asla herkese açık olarak göndermeyin. Üretim için Azure Key Vault gibi kimlik bilgilerinizi depolamanın ve bunlara erişmenin güvenli bir yolunu kullanın. Daha fazla bilgi için Azure AI hizmetleri güvenlik makalesine bakın.

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

    }
}

Çı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 | Ek ö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şturacaksınız.

İpucu

Kod yazmaya gerek kalmadan belgelerde PII algılamayı denemek için Language Studio'yu kullanabilirsiniz.

Önkoşullar

  • Azure aboneliği - Ücretsiz olarak oluşturun
  • Java Geliştirme Seti (JDK) sürüm 8 veya üstü
  • Azure aboneliğinizi aldıktan sonra anahtarınızı ve uç noktanızı almak için Azure portalında bir Dil kaynağı oluşturun. Dağıtıldıktan sonra Kaynağa git'i seçin.
    • Uygulamanızı API'ye bağlamak için oluşturduğunuz kaynaktan anahtara ve uç noktaya ihtiyacınız olacaktır. Anahtarınızı ve uç noktanızı hızlı başlangıcın ilerleyen bölümlerinde aşağıdaki koda yapıştıracaksınız.
    • Hizmeti denemek ve daha sonra üretim için ücretli bir katmana yükseltmek için ücretsiz fiyatlandırma katmanını (Free F0) kullanabilirsiniz.
  • Çözümle özelliğini kullanmak için standart (S) fiyatlandırma katmanına sahip bir Dil kaynağı gerekir.

Ayarlama

İ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. değişkeni kaynağınızın anahtarıyla değiştirmeyi key ve değişkeni kaynağınızın uç noktasıyla değiştirmeyi endpoint unutmayın.

Önemli

Azure portalına gidin. Önkoşullar bölümünde oluşturduğunuz Dil kaynağı başarıyla dağıtıldıysa, Sonraki Adımlar'ın altındaki Kaynağa Git düğmesine tıklayın. Kaynağınızın Anahtarlar ve Uç Nokta sayfasına gidip Kaynak Yönetimi'nin altında anahtarınızı ve uç noktanızı bulabilirsiniz.

Önemli

İşiniz bittiğinde anahtarı kodunuzdan kaldırmayı unutmayın ve asla herkese açık olarak göndermeyin. Üretim için Azure Key Vault gibi kimlik bilgilerinizi depolamanın ve bunlara erişmenin güvenli bir yolunu kullanın. Daha fazla bilgi için Azure AI hizmetleri güvenlik makalesine bakı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 {

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

Çı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 | Ek ö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şturacaksınız.

İpucu

Kod yazmaya gerek kalmadan belgelerde PII algılamayı denemek için Language Studio'yu kullanabilirsiniz.

Önkoşullar

  • Azure aboneliği - Ücretsiz olarak oluşturun
  • Node.js v14 LTS veya üzeri
  • Azure aboneliğinizi aldıktan sonra anahtarınızı ve uç noktanızı almak için Azure portalında bir Dil kaynağı oluşturun. Dağıtıldıktan sonra Kaynağa git'i seçin.
    • uygulamanızı API'ye bağlamak için oluşturduğunuz kaynaktan anahtara ve uç noktaya ihtiyacınız olacaktır. Anahtarınızı ve uç noktanızı hızlı başlangıcın ilerleyen bölümlerinde aşağıdaki koda yapıştıracaksınız.
    • Hizmeti denemek ve daha sonra üretim için ücretli bir katmana yükseltmek için ücretsiz fiyatlandırma katmanını (Free F0) kullanabilirsiniz.
  • Çözümle özelliğini kullanmak için standart (S) fiyatlandırma katmanına sahip bir Dil kaynağı gerekir.

Ayarlama

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. değişkeni kaynağınızın anahtarıyla değiştirmeyi key ve değişkeni kaynağınızın uç noktasıyla değiştirmeyi endpoint unutmayın.

Önemli

Azure portalına gidin. Önkoşullar bölümünde oluşturduğunuz Dil kaynağı başarıyla dağıtıldıysa, Sonraki Adımlar'ın altındaki Kaynağa Git düğmesine tıklayın. Kaynağınızın Anahtarlar ve Uç Nokta sayfasına gidip Kaynak Yönetimi'nin altında anahtarınızı ve uç noktanızı bulabilirsiniz.

Önemli

İşiniz bittiğinde anahtarı kodunuzdan kaldırmayı unutmayın ve asla herkese açık olarak göndermeyin. Üretim için Azure Key Vault gibi kimlik bilgilerinizi depolamanın ve bunlara erişmenin güvenli bir yolunu kullanın. Daha fazla bilgi için Azure AI hizmetleri güvenlik makalesine bakın.

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

Çıktı

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

Başvuru belgeleri | Ek ö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.

İpucu

Kod yazmaya gerek kalmadan belgelerde PII algılamayı denemek için Language Studio'yu kullanabilirsiniz.

Önkoşullar

  • Azure aboneliği - Ücretsiz olarak oluşturun
  • Python 3.8 veya üzeri
  • Azure aboneliğinizi aldıktan sonra anahtarınızı ve uç noktanızı almak için Azure portalında bir Dil kaynağı oluşturun. Dağıtıldıktan sonra Kaynağa git'i seçin.
    • Uygulamanızı API'ye bağlamak için oluşturduğunuz kaynaktan anahtara ve uç noktaya ihtiyacınız olacaktır. Anahtarınızı ve uç noktanızı hızlı başlangıcın ilerleyen bölümlerinde aşağıdaki koda yapıştıracaksınız.
    • Hizmeti denemek ve daha sonra üretim için ücretli bir katmana yükseltmek için ücretsiz fiyatlandırma katmanını (Free F0) kullanabilirsiniz.
  • Çözümle özelliğini kullanmak için standart (S) fiyatlandırma katmanına sahip bir Dil kaynağı gerekir.

Ayarlama

İ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. değişkeni kaynağınızın anahtarıyla değiştirmeyi key ve değişkeni kaynağınızın uç noktasıyla değiştirmeyi endpoint unutmayın.

Önemli

Azure portalına gidin. Önkoşullar bölümünde oluşturduğunuz Dil kaynağı başarıyla dağıtıldıysa, Sonraki Adımlar'ın altındaki Kaynağa Git düğmesine tıklayın. Kaynağınızın Anahtarlar ve Uç Nokta sayfasına gidip Kaynak Yönetimi'nin altında anahtarınızı ve uç noktanızı bulabilirsiniz.

Önemli

İşiniz bittiğinde anahtarı kodunuzdan kaldırmayı unutmayın ve asla herkese açık olarak göndermeyin. Üretim için Azure Key Vault gibi kimlik bilgilerinizi depolamanın ve bunlara erişmenin güvenli bir yolunu kullanın. Daha fazla bilgi için Azure AI hizmetleri güvenlik makalesine bakın.

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)

Çı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.

İpucu

Kod yazmaya gerek kalmadan belgelerde PII algılamayı denemek için Language Studio'yu kullanabilirsiniz.

Önkoşullar

  • cURL'nin geçerli sürümü.
  • Azure aboneliğinizi aldıktan sonra anahtarınızı ve uç noktanızı almak için Azure portalında bir Dil kaynağı oluşturun. Dağıtıldıktan sonra Kaynağa git'i seçin.
    • Uygulamanızı API'ye bağlamak için oluşturduğunuz kaynaktan anahtara ve uç noktaya ihtiyacınız olacaktır. Anahtarınızı ve uç noktanızı hızlı başlangıcın ilerleyen bölümlerinde aşağıdaki koda yapıştıracaksınız.
    • Hizmeti denemek ve daha sonra üretim için ücretli bir katmana yükseltmek için ücretsiz fiyatlandırma katmanını (Free F0) kullanabilirsiniz.

Not

  • Aşağıdaki BASH örneklerinde satır devamlılığı karakteri kullanılır \ . Konsolunuz veya terminaliniz farklı bir satır devamlılığı karakteri kullanıyorsa bu karakteri kullanın.
  • Dile özgü örnekleri GitHub'da bulabilirsiniz.
  • Azure portalına gidin ve önkoşullarda oluşturduğunuz Dil kaynağının anahtarını ve uç noktasını bulun. Bunlar kaynağın anahtarı ve uç noktası sayfasında, kaynak yönetimi altında bulunur. Ardından aşağıdaki koddaki dizeleri anahtarınızla ve uç noktanızla değiştirin. API'yi çağırmak için aşağıdaki bilgilere ihtiyacınız vardır:
parametre Açıklama
-X POST <endpoint> API'ye erişmek için uç noktanızı belirtir.
-H Content-Type: application/json JSON verilerini göndermek için içerik türü.
-H "Ocp-Apim-Subscription-Key:<key> API'ye erişmek için anahtarı belirtir.
-d <documents> Göndermek istediğiniz belgeleri içeren JSON.

Aşağıdaki cURL komutları bir BASH kabuğundan yürütülür. Bu komutları kendi kaynak adınız, kaynak anahtarınız ve JSON değerlerinizle düzenleyin.

Kişisel Kimlik Bilgileri (PII) algılama

  1. Komutu bir metin düzenleyicisine kopyalayın.
  2. Gerektiğinde komutta aşağıdaki değişiklikleri yapın:
    1. değerini <your-language-resource-key> anahtarınız ile değiştirin.
    2. İstek URL'sinin ilk bölümünü uç nokta URL'nizle <your-language-resource-endpoint> değiştirin.
  3. Bir komut istemi penceresi açın.
  4. Metin düzenleyicisindeki komutu komut istemi penceresine yapıştırın ve komutu çalıştırın.
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"
            }
        ]
    }
}
'

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

Kaynakları temizleme

Azure AI hizmetleri aboneliğini temizlemek ve kaldırmak istiyorsanız, kaynağı veya kaynak grubunu silebilirsiniz. Kaynak grubunun silinmesi, kaynak grubuyla ilişkili diğer tüm kaynakları da siler.

Sonraki adımlar