Mulai Cepat: Penautan Entitas menggunakan pustaka klien dan REST API

Dokumentasi | referensi Paket sampel | lainnya (NuGet) | Kode sumber pustaka

Gunakan mulai cepat ini untuk membuat aplikasi penautan entitas dengan pustaka klien untuk .NET. Dalam contoh berikut, Anda membuat aplikasi C# yang dapat mengidentifikasi dan membedakan entitas yang ditemukan dalam teks.

Tip

Anda dapat menggunakan Studio Bahasa untuk mencoba fitur layanan Bahasa tanpa perlu menulis kode.

Prasyarat

Menyiapkan

Membuat grup sumber daya Azure

Untuk menggunakan sampel kode di bawah ini, Anda harus menyebarkan sumber daya Azure. Sumber daya ini akan berisi kunci dan titik akhir yang akan Anda gunakan untuk mengautentikasi panggilan API yang Anda kirim ke layanan Bahasa.

  1. Gunakan tautan berikut untuk membuat sumber daya bahasa menggunakan portal Azure. Anda harus masuk menggunakan langganan Azure Anda.

  2. Pada layar Pilih fitur tambahan yang muncul, pilih Lanjutkan untuk membuat sumber daya Anda.

    Cuplikan layar memperlihatkan opsi fitur tambahan di portal Azure.

  3. Di layar Buat bahasa, berikan informasi berikut ini:

    Detail Deskripsi
    Langganan Akun langganan yang akan dikaitkan dengan sumber daya Anda. Pilih langganan Azure Anda dari menu drop-down.
    Grup sumber daya Grup sumber daya adalah kontainer yang menyimpan sumber daya yang Anda buat. Pilih Buat baru untuk membuat grup sumber daya baru.
    Wilayah Lokasi sumber daya Bahasa Anda. Wilayah yang berbeda dapat memperkenalkan latensi tergantung pada lokasi fisik Anda, tetapi tidak berdampak pada ketersediaan runtime sumber daya Anda. Untuk mulai cepat ini, pilih wilayah yang tersedia di dekat Anda, atau pilih US Timur.
    Nama Nama untuk sumber daya Bahasa Anda. Nama ini juga akan digunakan untuk membuat URL titik akhir yang akan digunakan aplikasi Anda untuk mengirim permintaan API.
    Tingkatan harga Tingkat harga untuk sumber daya Bahasa Anda. Anda dapat menggunakan tingkat F0 Gratis untuk mencoba layanan dan meningkatkannya nanti ke tingkat berbayar untuk produksi.

    Cuplikan layar memperlihatkan detail pembuatan sumber daya di portal Azure.

  4. Pastikan kotak centang Pemberitahuan AI Bertanggung Jawab dicentang.

  5. Pilih Tinjau + Buat di bagian bawah halaman.

  6. Di layar yang muncul, pastikan validasi telah berlalu, dan Anda memasukkan informasi dengan benar. Lalu pilih Buat.

Dapatkan kunci dan titik akhir Anda

Selanjutnya Anda akan memerlukan kunci dan titik akhir dari sumber daya untuk menghubungkan aplikasi Anda ke API. Anda akan menempelkan kunci dan titik akhir Anda ke dalam kode di mulai cepat nanti.

  1. Setelah sumber daya Bahasa berhasil disebarkan, klik tombol Buka Sumber Daya di bawah Langkah Berikutnya.

    Cuplikan layar memperlihatkan langkah berikutnya setelah sumber daya disebarkan.

  2. Pada layar untuk sumber daya Anda, pilih Kunci dan titik akhir di menu navigasi kiri. Anda akan menggunakan salah satu kunci dan titik akhir Anda dalam langkah-langkah di bawah ini.

    Cuplikan layar memperlihatkan bagian kunci dan titik akhir untuk sumber daya.

Membuat variabel lingkungan

Aplikasi Anda harus diautentikasi untuk mengirim permintaan API. Untuk produksi, gunakan cara yang aman dalam menyimpan dan mengakses info masuk Anda. Dalam contoh ini, Anda akan menulis kredensial Anda ke variabel lingkungan pada komputer lokal yang menjalankan aplikasi.

Tip

Jangan sertakan kunci langsung dalam kode Anda, dan jangan pernah mempostingnya secara publik. Lihat artikel keamanan layanan Azure AI untuk opsi autentikasi lainnya seperti Azure Key Vault.

Untuk mengatur variabel lingkungan untuk kunci sumber daya Bahasa Anda, buka jendela konsol, dan ikuti instruksi untuk sistem operasi dan lingkungan pengembangan Anda.

  1. Untuk mengatur LANGUAGE_KEY variabel lingkungan, ganti your-key dengan salah satu kunci untuk sumber daya Anda.
  2. Untuk mengatur LANGUAGE_ENDPOINT variabel lingkungan, ganti your-endpoint dengan titik akhir untuk sumber daya Anda.
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint

Catatan

Jika Anda hanya perlu mengakses variabel lingkungan di konsol yang sedang berjalan saat ini, Anda dapat mengatur variabel lingkungan dengan set alih-alih setx.

Setelah menambahkan variabel lingkungan, Anda mungkin perlu memulai ulang program yang sedang berjalan yang perlu membaca variabel lingkungan, termasuk jendela konsol. Misalnya, jika Anda menggunakan Visual Studio sebagai editor, hidupkan ulang Visual Studio sebelum menjalankan contoh.

Buat aplikasi .NET Core baru

Menggunakan Ide Visual Studio, buat aplikasi konsol .NET Core baru. Ini akan membuat proyek "Halo Dunia" dengan satu file sumber C#: program.cs.

Pasang pustaka klien dengan mengeklik kanan solusi proyek di Penjelajah Solusi, lalu pilih Kelola Paket NuGet. Di manajer paket yang terbuka pilih Telusuri dan cari Azure.AI.TextAnalytics. Pilih versi 5.2.0, lalu Pasang. Anda juga dapat menggunakan Package Manager Console.

Contoh kode

Salin kode berikut ke file program.cs Anda dan jalankan kode.

using Azure;
using System;
using System.Globalization;
using Azure.AI.TextAnalytics;

namespace EntityLinkingExample
{
    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 recognizing entities and providing a link to an online data source.
        static void EntityLinkingExample(TextAnalyticsClient client)
        {
            var response = client.RecognizeLinkedEntities(
                "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, " +
                "to develop and sell BASIC interpreters for the Altair 8800. " +
                "During his career at Microsoft, Gates held the positions of chairman, " +
                "chief executive officer, president and chief software architect, " +
                "while also being the largest individual shareholder until May 2014.");
            Console.WriteLine("Linked Entities:");
            foreach (var entity in response.Value)
            {
                Console.WriteLine($"\tName: {entity.Name},\tID: {entity.DataSourceEntityId},\tURL: {entity.Url}\tData Source: {entity.DataSource}");
                Console.WriteLine("\tMatches:");
                foreach (var match in entity.Matches)
                {
                    Console.WriteLine($"\t\tText: {match.Text}");
                    Console.WriteLine($"\t\tScore: {match.ConfidenceScore:F2}\n");
                }
            }
        }

        static void Main(string[] args)
        {
            var client = new TextAnalyticsClient(endpoint, credentials);
            EntityLinkingExample(client);

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

    }
}

Output

Linked Entities:
    Name: Microsoft,        ID: Microsoft,  URL: https://en.wikipedia.org/wiki/Microsoft    Data Source: Wikipedia
    Matches:
            Text: Microsoft
            Score: 0.55

            Text: Microsoft
            Score: 0.55

    Name: Bill Gates,       ID: Bill Gates, URL: https://en.wikipedia.org/wiki/Bill_Gates   Data Source: Wikipedia
    Matches:
            Text: Bill Gates
            Score: 0.63

            Text: Gates
            Score: 0.63

    Name: Paul Allen,       ID: Paul Allen, URL: https://en.wikipedia.org/wiki/Paul_Allen   Data Source: Wikipedia
    Matches:
            Text: Paul Allen
            Score: 0.60

    Name: April 4,  ID: April 4,    URL: https://en.wikipedia.org/wiki/April_4      Data Source: Wikipedia
    Matches:
            Text: April 4
            Score: 0.32

    Name: BASIC,    ID: BASIC,      URL: https://en.wikipedia.org/wiki/BASIC        Data Source: Wikipedia
    Matches:
            Text: BASIC
            Score: 0.33

    Name: Altair 8800,      ID: Altair 8800,        URL: https://en.wikipedia.org/wiki/Altair_8800  Data Source: Wikipedia
    Matches:
            Text: Altair 8800
            Score: 0.88

Membersihkan sumber daya

Jika Anda ingin membersihkan dan menghapus langganan layanan Azure AI, Anda dapat menghapus sumber daya atau grup sumber daya. Menghapus grup sumber daya juga menghapus sumber daya apa pun yang terkait dengannya.

Langkah berikutnya

Dokumentasi | referensi Paket sampel | lainnya (Maven) | Kode sumber pustaka

Gunakan mulai cepat ini untuk membuat aplikasi penautan entitas dengan pustaka klien untuk Java. Dalam contoh berikut, Anda membuat aplikasi Java yang dapat mengidentifikasi dan membedakan entitas yang ditemukan dalam teks.

Prasyarat

Menyiapkan

Membuat grup sumber daya Azure

Untuk menggunakan sampel kode di bawah ini, Anda harus menyebarkan sumber daya Azure. Sumber daya ini akan berisi kunci dan titik akhir yang akan Anda gunakan untuk mengautentikasi panggilan API yang Anda kirim ke layanan Bahasa.

  1. Gunakan tautan berikut untuk membuat sumber daya bahasa menggunakan portal Azure. Anda harus masuk menggunakan langganan Azure Anda.

  2. Pada layar Pilih fitur tambahan yang muncul, pilih Lanjutkan untuk membuat sumber daya Anda.

    Cuplikan layar memperlihatkan opsi fitur tambahan di portal Azure.

  3. Di layar Buat bahasa, berikan informasi berikut ini:

    Detail Deskripsi
    Langganan Akun langganan yang akan dikaitkan dengan sumber daya Anda. Pilih langganan Azure Anda dari menu drop-down.
    Grup sumber daya Grup sumber daya adalah kontainer yang menyimpan sumber daya yang Anda buat. Pilih Buat baru untuk membuat grup sumber daya baru.
    Wilayah Lokasi sumber daya Bahasa Anda. Wilayah yang berbeda dapat memperkenalkan latensi tergantung pada lokasi fisik Anda, tetapi tidak berdampak pada ketersediaan runtime sumber daya Anda. Untuk mulai cepat ini, pilih wilayah yang tersedia di dekat Anda, atau pilih US Timur.
    Nama Nama untuk sumber daya Bahasa Anda. Nama ini juga akan digunakan untuk membuat URL titik akhir yang akan digunakan aplikasi Anda untuk mengirim permintaan API.
    Tingkatan harga Tingkat harga untuk sumber daya Bahasa Anda. Anda dapat menggunakan tingkat F0 Gratis untuk mencoba layanan dan meningkatkannya nanti ke tingkat berbayar untuk produksi.

    Cuplikan layar memperlihatkan detail pembuatan sumber daya di portal Azure.

  4. Pastikan kotak centang Pemberitahuan AI Bertanggung Jawab dicentang.

  5. Pilih Tinjau + Buat di bagian bawah halaman.

  6. Di layar yang muncul, pastikan validasi telah berlalu, dan Anda memasukkan informasi dengan benar. Lalu pilih Buat.

Dapatkan kunci dan titik akhir Anda

Selanjutnya Anda akan memerlukan kunci dan titik akhir dari sumber daya untuk menghubungkan aplikasi Anda ke API. Anda akan menempelkan kunci dan titik akhir Anda ke dalam kode di mulai cepat nanti.

  1. Setelah sumber daya Bahasa berhasil disebarkan, klik tombol Buka Sumber Daya di bawah Langkah Berikutnya.

    Cuplikan layar memperlihatkan langkah berikutnya setelah sumber daya disebarkan.

  2. Pada layar untuk sumber daya Anda, pilih Kunci dan titik akhir di menu navigasi kiri. Anda akan menggunakan salah satu kunci dan titik akhir Anda dalam langkah-langkah di bawah ini.

    Cuplikan layar memperlihatkan bagian kunci dan titik akhir untuk sumber daya.

Membuat variabel lingkungan

Aplikasi Anda harus diautentikasi untuk mengirim permintaan API. Untuk produksi, gunakan cara yang aman dalam menyimpan dan mengakses info masuk Anda. Dalam contoh ini, Anda akan menulis kredensial Anda ke variabel lingkungan pada komputer lokal yang menjalankan aplikasi.

Tip

Jangan sertakan kunci langsung dalam kode Anda, dan jangan pernah mempostingnya secara publik. Lihat artikel keamanan layanan Azure AI untuk opsi autentikasi lainnya seperti Azure Key Vault.

Untuk mengatur variabel lingkungan untuk kunci sumber daya Bahasa Anda, buka jendela konsol, dan ikuti instruksi untuk sistem operasi dan lingkungan pengembangan Anda.

  1. Untuk mengatur LANGUAGE_KEY variabel lingkungan, ganti your-key dengan salah satu kunci untuk sumber daya Anda.
  2. Untuk mengatur LANGUAGE_ENDPOINT variabel lingkungan, ganti your-endpoint dengan titik akhir untuk sumber daya Anda.
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint

Catatan

Jika Anda hanya perlu mengakses variabel lingkungan di konsol yang sedang berjalan saat ini, Anda dapat mengatur variabel lingkungan dengan set alih-alih setx.

Setelah menambahkan variabel lingkungan, Anda mungkin perlu memulai ulang program yang sedang berjalan yang perlu membaca variabel lingkungan, termasuk jendela konsol. Misalnya, jika Anda menggunakan Visual Studio sebagai editor, hidupkan ulang Visual Studio sebelum menjalankan contoh.

Tambahkan pustaka klien

Buat proyek Maven di IDE atau lingkungan pengembangan pilihan Anda. Kemudian, tambahkan dependensi berikut ke file pom.xml proyek Anda. Anda dapat menemukan sintaks implementasi untuk alat build online lainnya.

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

Contoh kode

Buat file Java bernama Example.java. Buka file dan salin kode di bawah ini. Kemudian jalankan kode.

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);
        recognizeLinkedEntitiesExample(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 recognizing entities and providing a link to an online data source
    static void recognizeLinkedEntitiesExample(TextAnalyticsClient client)
    {
        // The text that need be analyzed.
        String text = "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, " +
                "to develop and sell BASIC interpreters for the Altair 8800. " +
                "During his career at Microsoft, Gates held the positions of chairman, " +
                "chief executive officer, president and chief software architect, " +
                "while also being the largest individual shareholder until May 2014.";

        System.out.printf("Linked Entities:%n");
        for (LinkedEntity linkedEntity : client.recognizeLinkedEntities(text)) {
            System.out.printf("Name: %s, ID: %s, URL: %s, Data Source: %s.%n",
                    linkedEntity.getName(),
                    linkedEntity.getDataSourceEntityId(),
                    linkedEntity.getUrl(),
                    linkedEntity.getDataSource());
            System.out.printf("Matches:%n");
            for (LinkedEntityMatch linkedEntityMatch : linkedEntity.getMatches()) {
                System.out.printf("Text: %s, Score: %.2f, Offset: %s, Length: %s%n",
                        linkedEntityMatch.getText(),
                        linkedEntityMatch.getConfidenceScore(),
                        linkedEntityMatch.getOffset(),
                        linkedEntityMatch.getLength());
            }
        }
    }
}

Output

Linked Entities:

Name: Microsoft, ID: Microsoft, URL: https://en.wikipedia.org/wiki/Microsoft, Data Source: Wikipedia.
Matches:
Text: Microsoft, Score: 0.55, Offset: 0, Length: 9
Text: Microsoft, Score: 0.55, Offset: 150, Length: 9
Name: Bill Gates, ID: Bill Gates, URL: https://en.wikipedia.org/wiki/Bill_Gates, Data Source: Wikipedia.
Matches:
Text: Bill Gates, Score: 0.63, Offset: 25, Length: 10
Text: Gates, Score: 0.63, Offset: 161, Length: 5
Name: Paul Allen, ID: Paul Allen, URL: https://en.wikipedia.org/wiki/Paul_Allen, Data Source: Wikipedia.
Matches:
Text: Paul Allen, Score: 0.60, Offset: 40, Length: 10
Name: April 4, ID: April 4, URL: https://en.wikipedia.org/wiki/April_4, Data Source: Wikipedia.
Matches:
Text: April 4, Score: 0.32, Offset: 54, Length: 7
Name: BASIC, ID: BASIC, URL: https://en.wikipedia.org/wiki/BASIC, Data Source: Wikipedia.
Matches:
Text: BASIC, Score: 0.33, Offset: 89, Length: 5
Name: Altair 8800, ID: Altair 8800, URL: https://en.wikipedia.org/wiki/Altair_8800, Data Source: Wikipedia.
Matches:
Text: Altair 8800, Score: 0.88, Offset: 116, Length: 11

Membersihkan sumber daya

Jika Anda ingin membersihkan dan menghapus langganan layanan Azure AI, Anda dapat menghapus sumber daya atau grup sumber daya. Menghapus grup sumber daya juga menghapus sumber daya apa pun yang terkait dengannya.

Langkah berikutnya

Dokumentasi | referensi Paket sampel | lainnya (npm) | Kode sumber pustaka

Gunakan mulai cepat ini untuk membuat aplikasi penautan entitas dengan pustaka klien untuk Node.js. Dalam contoh berikut, Anda membuat aplikasi JavaScript yang dapat mengidentifikasi dan membedakan entitas yang ditemukan dalam teks.

Prasyarat

Menyiapkan

Membuat grup sumber daya Azure

Untuk menggunakan sampel kode di bawah ini, Anda harus menyebarkan sumber daya Azure. Sumber daya ini akan berisi kunci dan titik akhir yang akan Anda gunakan untuk mengautentikasi panggilan API yang Anda kirim ke layanan Bahasa.

  1. Gunakan tautan berikut untuk membuat sumber daya bahasa menggunakan portal Azure. Anda harus masuk menggunakan langganan Azure Anda.

  2. Pada layar Pilih fitur tambahan yang muncul, pilih Lanjutkan untuk membuat sumber daya Anda.

    Cuplikan layar memperlihatkan opsi fitur tambahan di portal Azure.

  3. Di layar Buat bahasa, berikan informasi berikut ini:

    Detail Deskripsi
    Langganan Akun langganan yang akan dikaitkan dengan sumber daya Anda. Pilih langganan Azure Anda dari menu drop-down.
    Grup sumber daya Grup sumber daya adalah kontainer yang menyimpan sumber daya yang Anda buat. Pilih Buat baru untuk membuat grup sumber daya baru.
    Wilayah Lokasi sumber daya Bahasa Anda. Wilayah yang berbeda dapat memperkenalkan latensi tergantung pada lokasi fisik Anda, tetapi tidak berdampak pada ketersediaan runtime sumber daya Anda. Untuk mulai cepat ini, pilih wilayah yang tersedia di dekat Anda, atau pilih US Timur.
    Nama Nama untuk sumber daya Bahasa Anda. Nama ini juga akan digunakan untuk membuat URL titik akhir yang akan digunakan aplikasi Anda untuk mengirim permintaan API.
    Tingkatan harga Tingkat harga untuk sumber daya Bahasa Anda. Anda dapat menggunakan tingkat F0 Gratis untuk mencoba layanan dan meningkatkannya nanti ke tingkat berbayar untuk produksi.

    Cuplikan layar memperlihatkan detail pembuatan sumber daya di portal Azure.

  4. Pastikan kotak centang Pemberitahuan AI Bertanggung Jawab dicentang.

  5. Pilih Tinjau + Buat di bagian bawah halaman.

  6. Di layar yang muncul, pastikan validasi telah berlalu, dan Anda memasukkan informasi dengan benar. Lalu pilih Buat.

Dapatkan kunci dan titik akhir Anda

Selanjutnya Anda akan memerlukan kunci dan titik akhir dari sumber daya untuk menghubungkan aplikasi Anda ke API. Anda akan menempelkan kunci dan titik akhir Anda ke dalam kode di mulai cepat nanti.

  1. Setelah sumber daya Bahasa berhasil disebarkan, klik tombol Buka Sumber Daya di bawah Langkah Berikutnya.

    Cuplikan layar memperlihatkan langkah berikutnya setelah sumber daya disebarkan.

  2. Pada layar untuk sumber daya Anda, pilih Kunci dan titik akhir di menu navigasi kiri. Anda akan menggunakan salah satu kunci dan titik akhir Anda dalam langkah-langkah di bawah ini.

    Cuplikan layar memperlihatkan bagian kunci dan titik akhir untuk sumber daya.

Membuat variabel lingkungan

Aplikasi Anda harus diautentikasi untuk mengirim permintaan API. Untuk produksi, gunakan cara yang aman dalam menyimpan dan mengakses info masuk Anda. Dalam contoh ini, Anda akan menulis kredensial Anda ke variabel lingkungan pada komputer lokal yang menjalankan aplikasi.

Tip

Jangan sertakan kunci langsung dalam kode Anda, dan jangan pernah mempostingnya secara publik. Lihat artikel keamanan layanan Azure AI untuk opsi autentikasi lainnya seperti Azure Key Vault.

Untuk mengatur variabel lingkungan untuk kunci sumber daya Bahasa Anda, buka jendela konsol, dan ikuti instruksi untuk sistem operasi dan lingkungan pengembangan Anda.

  1. Untuk mengatur LANGUAGE_KEY variabel lingkungan, ganti your-key dengan salah satu kunci untuk sumber daya Anda.
  2. Untuk mengatur LANGUAGE_ENDPOINT variabel lingkungan, ganti your-endpoint dengan titik akhir untuk sumber daya Anda.
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint

Catatan

Jika Anda hanya perlu mengakses variabel lingkungan di konsol yang sedang berjalan saat ini, Anda dapat mengatur variabel lingkungan dengan set alih-alih setx.

Setelah menambahkan variabel lingkungan, Anda mungkin perlu memulai ulang program yang sedang berjalan yang perlu membaca variabel lingkungan, termasuk jendela konsol. Misalnya, jika Anda menggunakan Visual Studio sebagai editor, hidupkan ulang Visual Studio sebelum menjalankan contoh.

Membuat aplikasi Node.js baru

Di jendela konsol (seperti cmd, PowerShell, atau Bash), buat direktori baru untuk aplikasi Anda, dan buka direktori tersebut.

mkdir myapp 

cd myapp

Jalankan perintah npm init untuk membuat aplikasi node dengan file package.json.

npm init

Memasang pustaka klien

Instal paket npm:

npm install @azure/ai-language-text

Contoh kode

Buka file dan salin kode di bawah ini. Kemudian jalankan kode.

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

//example sentence for recognizing entities
const documents = ["Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975."];

//example of how to use the client to perform entity linking on a document
async function main() {
    console.log("== Entity linking sample ==");
  
    const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
  
    const results = await client.analyze("EntityLinking", documents);
  
    for (const result of results) {
      console.log(`- Document ${result.id}`);
      if (!result.error) {
        console.log("\tEntities:");
        for (const entity of result.entities) {
          console.log(
            `\t- Entity ${entity.name}; link ${entity.url}; datasource: ${entity.dataSource}`
          );
          console.log("\t\tMatches:");
          for (const match of entity.matches) {
            console.log(
              `\t\t- Entity appears as "${match.text}" (confidence: ${match.confidenceScore}`
            );
          }
        }
      } else {
        console.error("  Error:", result.error);
      }
    }
  }

//call the main function
main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Output

== Entity linking sample ==
- Document 0
    Entities:
    - Entity Microsoft; link https://en.wikipedia.org/wiki/Microsoft; datasource: Wikipedia
            Matches:
            - Entity appears as "Microsoft" (confidence: 0.48
    - Entity Bill Gates; link https://en.wikipedia.org/wiki/Bill_Gates; datasource: Wikipedia
            Matches:
            - Entity appears as "Bill Gates" (confidence: 0.52
    - Entity Paul Allen; link https://en.wikipedia.org/wiki/Paul_Allen; datasource: Wikipedia
            Matches:
            - Entity appears as "Paul Allen" (confidence: 0.54
    - Entity April 4; link https://en.wikipedia.org/wiki/April_4; datasource: Wikipedia
            Matches:
            - Entity appears as "April 4" (confidence: 0.38

Membersihkan sumber daya

Jika Anda ingin membersihkan dan menghapus langganan layanan Azure AI, Anda dapat menghapus sumber daya atau grup sumber daya. Menghapus grup sumber daya juga menghapus sumber daya apa pun yang terkait dengannya.

Langkah berikutnya

Dokumentasi | referensi Paket sampel | lainnya (PyPi) | Kode sumber pustaka

Gunakan mulai cepat ini untuk membuat aplikasi penautan entitas dengan pustaka klien untuk Python. Dalam contoh berikut, Anda membuat aplikasi Python yang dapat mengidentifikasi dan membedakan entitas yang ditemukan dalam teks.

Prasyarat

Menyiapkan

Membuat grup sumber daya Azure

Untuk menggunakan sampel kode di bawah ini, Anda harus menyebarkan sumber daya Azure. Sumber daya ini akan berisi kunci dan titik akhir yang akan Anda gunakan untuk mengautentikasi panggilan API yang Anda kirim ke layanan Bahasa.

  1. Gunakan tautan berikut untuk membuat sumber daya bahasa menggunakan portal Azure. Anda harus masuk menggunakan langganan Azure Anda.

  2. Pada layar Pilih fitur tambahan yang muncul, pilih Lanjutkan untuk membuat sumber daya Anda.

    Cuplikan layar memperlihatkan opsi fitur tambahan di portal Azure.

  3. Di layar Buat bahasa, berikan informasi berikut ini:

    Detail Deskripsi
    Langganan Akun langganan yang akan dikaitkan dengan sumber daya Anda. Pilih langganan Azure Anda dari menu drop-down.
    Grup sumber daya Grup sumber daya adalah kontainer yang menyimpan sumber daya yang Anda buat. Pilih Buat baru untuk membuat grup sumber daya baru.
    Wilayah Lokasi sumber daya Bahasa Anda. Wilayah yang berbeda dapat memperkenalkan latensi tergantung pada lokasi fisik Anda, tetapi tidak berdampak pada ketersediaan runtime sumber daya Anda. Untuk mulai cepat ini, pilih wilayah yang tersedia di dekat Anda, atau pilih US Timur.
    Nama Nama untuk sumber daya Bahasa Anda. Nama ini juga akan digunakan untuk membuat URL titik akhir yang akan digunakan aplikasi Anda untuk mengirim permintaan API.
    Tingkatan harga Tingkat harga untuk sumber daya Bahasa Anda. Anda dapat menggunakan tingkat F0 Gratis untuk mencoba layanan dan meningkatkannya nanti ke tingkat berbayar untuk produksi.

    Cuplikan layar memperlihatkan detail pembuatan sumber daya di portal Azure.

  4. Pastikan kotak centang Pemberitahuan AI Bertanggung Jawab dicentang.

  5. Pilih Tinjau + Buat di bagian bawah halaman.

  6. Di layar yang muncul, pastikan validasi telah berlalu, dan Anda memasukkan informasi dengan benar. Lalu pilih Buat.

Dapatkan kunci dan titik akhir Anda

Selanjutnya Anda akan memerlukan kunci dan titik akhir dari sumber daya untuk menghubungkan aplikasi Anda ke API. Anda akan menempelkan kunci dan titik akhir Anda ke dalam kode di mulai cepat nanti.

  1. Setelah sumber daya Bahasa berhasil disebarkan, klik tombol Buka Sumber Daya di bawah Langkah Berikutnya.

    Cuplikan layar memperlihatkan langkah berikutnya setelah sumber daya disebarkan.

  2. Pada layar untuk sumber daya Anda, pilih Kunci dan titik akhir di menu navigasi kiri. Anda akan menggunakan salah satu kunci dan titik akhir Anda dalam langkah-langkah di bawah ini.

    Cuplikan layar memperlihatkan bagian kunci dan titik akhir untuk sumber daya.

Membuat variabel lingkungan

Aplikasi Anda harus diautentikasi untuk mengirim permintaan API. Untuk produksi, gunakan cara yang aman dalam menyimpan dan mengakses info masuk Anda. Dalam contoh ini, Anda akan menulis kredensial Anda ke variabel lingkungan pada komputer lokal yang menjalankan aplikasi.

Tip

Jangan sertakan kunci langsung dalam kode Anda, dan jangan pernah mempostingnya secara publik. Lihat artikel keamanan layanan Azure AI untuk opsi autentikasi lainnya seperti Azure Key Vault.

Untuk mengatur variabel lingkungan untuk kunci sumber daya Bahasa Anda, buka jendela konsol, dan ikuti instruksi untuk sistem operasi dan lingkungan pengembangan Anda.

  1. Untuk mengatur LANGUAGE_KEY variabel lingkungan, ganti your-key dengan salah satu kunci untuk sumber daya Anda.
  2. Untuk mengatur LANGUAGE_ENDPOINT variabel lingkungan, ganti your-endpoint dengan titik akhir untuk sumber daya Anda.
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint

Catatan

Jika Anda hanya perlu mengakses variabel lingkungan di konsol yang sedang berjalan saat ini, Anda dapat mengatur variabel lingkungan dengan set alih-alih setx.

Setelah menambahkan variabel lingkungan, Anda mungkin perlu memulai ulang program yang sedang berjalan yang perlu membaca variabel lingkungan, termasuk jendela konsol. Misalnya, jika Anda menggunakan Visual Studio sebagai editor, hidupkan ulang Visual Studio sebelum menjalankan contoh.

Memasang pustaka klien

Setelah memasang Python, Anda dapat memasang pustaka klien dengan:

pip install azure-ai-textanalytics==5.2.0

Contoh kode

Buat file Python baru dan salin kode di bawah ini. Kemudian jalankan kode.

# 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 function for recognizing entities and providing a link to an online data source.
def entity_linking_example(client):

    try:
        documents = ["""Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, 
        to develop and sell BASIC interpreters for the Altair 8800. 
        During his career at Microsoft, Gates held the positions of chairman,
        chief executive officer, president and chief software architect, 
        while also being the largest individual shareholder until May 2014."""]
        result = client.recognize_linked_entities(documents = documents)[0]

        print("Linked Entities:\n")
        for entity in result.entities:
            print("\tName: ", entity.name, "\tId: ", entity.data_source_entity_id, "\tUrl: ", entity.url,
            "\n\tData Source: ", entity.data_source)
            print("\tMatches:")
            for match in entity.matches:
                print("\t\tText:", match.text)
                print("\t\tConfidence Score: {0:.2f}".format(match.confidence_score))
                print("\t\tOffset: {}".format(match.offset))
                print("\t\tLength: {}".format(match.length))
            
    except Exception as err:
        print("Encountered exception. {}".format(err))
entity_linking_example(client)

Output

Linked Entities:
    
    Name:  Microsoft        Id:  Microsoft  Url:  https://en.wikipedia.org/wiki/Microsoft
    Data Source:  Wikipedia
    Matches:
            Text: Microsoft
            Confidence Score: 0.55
            Offset: 0
            Length: 9
            Text: Microsoft
            Confidence Score: 0.55
            Offset: 168
            Length: 9
    Name:  Bill Gates       Id:  Bill Gates         Url:  https://en.wikipedia.org/wiki/Bill_Gates
    Data Source:  Wikipedia
    Matches:
            Text: Bill Gates
            Confidence Score: 0.63
            Offset: 25
            Length: 10
            Text: Gates
            Confidence Score: 0.63
            Offset: 179
            Length: 5
    Name:  Paul Allen       Id:  Paul Allen         Url:  https://en.wikipedia.org/wiki/Paul_Allen
    Data Source:  Wikipedia
    Matches:
            Text: Paul Allen
            Confidence Score: 0.60
            Offset: 40
            Length: 10
    Name:  April 4  Id:  April 4    Url:  https://en.wikipedia.org/wiki/April_4
    Data Source:  Wikipedia
    Matches:
            Text: BASIC
            Confidence Score: 0.33
            Offset: 98
            Length: 5
    Name:  Altair 8800      Id:  Altair 8800        Url:  https://en.wikipedia.org/wiki/Altair_8800
    Data Source:  Wikipedia
    Matches:
            Text: Altair 8800
            Confidence Score: 0.88
            Offset: 125
            Length: 11

Membersihkan sumber daya

Jika Anda ingin membersihkan dan menghapus langganan layanan Azure AI, Anda dapat menghapus sumber daya atau grup sumber daya. Menghapus grup sumber daya juga menghapus sumber daya apa pun yang terkait dengannya.

Langkah berikutnya

Dokumentasi rujukan

Gunakan mulai cepat ini untuk mengirim permintaan penautan entitas menggunakan REST API. Dalam contoh berikut, Anda akan menggunakan cURL untuk mengidentifikasi dan mendisambiguasi entitas yang ditemukan dalam teks.

Prasyarat

Menyiapkan

Membuat grup sumber daya Azure

Untuk menggunakan sampel kode di bawah ini, Anda harus menyebarkan sumber daya Azure. Sumber daya ini akan berisi kunci dan titik akhir yang akan Anda gunakan untuk mengautentikasi panggilan API yang Anda kirim ke layanan Bahasa.

  1. Gunakan tautan berikut untuk membuat sumber daya bahasa menggunakan portal Azure. Anda harus masuk menggunakan langganan Azure Anda.

  2. Pada layar Pilih fitur tambahan yang muncul, pilih Lanjutkan untuk membuat sumber daya Anda.

    Cuplikan layar memperlihatkan opsi fitur tambahan di portal Azure.

  3. Di layar Buat bahasa, berikan informasi berikut ini:

    Detail Deskripsi
    Langganan Akun langganan yang akan dikaitkan dengan sumber daya Anda. Pilih langganan Azure Anda dari menu drop-down.
    Grup sumber daya Grup sumber daya adalah kontainer yang menyimpan sumber daya yang Anda buat. Pilih Buat baru untuk membuat grup sumber daya baru.
    Wilayah Lokasi sumber daya Bahasa Anda. Wilayah yang berbeda dapat memperkenalkan latensi tergantung pada lokasi fisik Anda, tetapi tidak berdampak pada ketersediaan runtime sumber daya Anda. Untuk mulai cepat ini, pilih wilayah yang tersedia di dekat Anda, atau pilih US Timur.
    Nama Nama untuk sumber daya Bahasa Anda. Nama ini juga akan digunakan untuk membuat URL titik akhir yang akan digunakan aplikasi Anda untuk mengirim permintaan API.
    Tingkatan harga Tingkat harga untuk sumber daya Bahasa Anda. Anda dapat menggunakan tingkat F0 Gratis untuk mencoba layanan dan meningkatkannya nanti ke tingkat berbayar untuk produksi.

    Cuplikan layar memperlihatkan detail pembuatan sumber daya di portal Azure.

  4. Pastikan kotak centang Pemberitahuan AI Bertanggung Jawab dicentang.

  5. Pilih Tinjau + Buat di bagian bawah halaman.

  6. Di layar yang muncul, pastikan validasi telah berlalu, dan Anda memasukkan informasi dengan benar. Lalu pilih Buat.

Dapatkan kunci dan titik akhir Anda

Selanjutnya Anda akan memerlukan kunci dan titik akhir dari sumber daya untuk menghubungkan aplikasi Anda ke API. Anda akan menempelkan kunci dan titik akhir Anda ke dalam kode di mulai cepat nanti.

  1. Setelah sumber daya Bahasa berhasil disebarkan, klik tombol Buka Sumber Daya di bawah Langkah Berikutnya.

    Cuplikan layar memperlihatkan langkah berikutnya setelah sumber daya disebarkan.

  2. Pada layar untuk sumber daya Anda, pilih Kunci dan titik akhir di menu navigasi kiri. Anda akan menggunakan salah satu kunci dan titik akhir Anda dalam langkah-langkah di bawah ini.

    Cuplikan layar memperlihatkan bagian kunci dan titik akhir untuk sumber daya.

Membuat variabel lingkungan

Aplikasi Anda harus diautentikasi untuk mengirim permintaan API. Untuk produksi, gunakan cara yang aman dalam menyimpan dan mengakses info masuk Anda. Dalam contoh ini, Anda akan menulis kredensial Anda ke variabel lingkungan pada komputer lokal yang menjalankan aplikasi.

Tip

Jangan sertakan kunci langsung dalam kode Anda, dan jangan pernah mempostingnya secara publik. Lihat artikel keamanan layanan Azure AI untuk opsi autentikasi lainnya seperti Azure Key Vault.

Untuk mengatur variabel lingkungan untuk kunci sumber daya Bahasa Anda, buka jendela konsol, dan ikuti instruksi untuk sistem operasi dan lingkungan pengembangan Anda.

  1. Untuk mengatur LANGUAGE_KEY variabel lingkungan, ganti your-key dengan salah satu kunci untuk sumber daya Anda.
  2. Untuk mengatur LANGUAGE_ENDPOINT variabel lingkungan, ganti your-endpoint dengan titik akhir untuk sumber daya Anda.
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint

Catatan

Jika Anda hanya perlu mengakses variabel lingkungan di konsol yang sedang berjalan saat ini, Anda dapat mengatur variabel lingkungan dengan set alih-alih setx.

Setelah menambahkan variabel lingkungan, Anda mungkin perlu memulai ulang program yang sedang berjalan yang perlu membaca variabel lingkungan, termasuk jendela konsol. Misalnya, jika Anda menggunakan Visual Studio sebagai editor, hidupkan ulang Visual Studio sebelum menjalankan contoh.

Membuat file JSON dengan contoh isi permintaan

Di editor kode, buat file baru bernama test_entitylinking_payload.json dan salin contoh JSON berikut. Contoh permintaan ini akan dikirim ke API pada langkah berikutnya.

{
    "kind": "EntityLinking",
    "parameters": {
        "modelVersion": "latest"
    },
    "analysisInput":{
        "documents":[
            {
                "id":"1",
                "language":"en",
                "text": "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975."
            }
        ]
    }
}

Simpan test_entitylinking_payload.json di suatu tempat di komputer Anda. Misalnya, desktop Anda.

Mengirim permintaan API penautan entitas

Gunakan perintah berikut untuk mengirim permintaan API menggunakan program yang Anda gunakan. Salin perintah ke terminal Anda, dan jalankan.

parameter Deskripsi
-X POST <endpoint> Menentukan titik akhir Anda untuk mengakses API.
-H Content-Type: application/json Jenis konten untuk mengirim data JSON.
-H "Ocp-Apim-Subscription-Key:<key> Menentukan kunci untuk mengakses API.
-d <documents> JSON berisi dokumen yang ingin Anda kirim.

Ganti C:\Users\<myaccount>\Desktop\test_entitylinking_payload.json dengan lokasi contoh file permintaan JSON yang Anda buat di langkah sebelumnya.

Perintah

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_entitylinking_payload.json"

PowerShell

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_entitylinking_payload.json"

Respons JSON

{
	"kind": "EntityLinkingResults",
	"results": {
		"documents": [{
			"id": "1",
			"entities": [{
				"bingId": "a093e9b9-90f5-a3d5-c4b8-5855e1b01f85",
				"name": "Microsoft",
				"matches": [{
					"text": "Microsoft",
					"offset": 0,
					"length": 9,
					"confidenceScore": 0.48
				}],
				"language": "en",
				"id": "Microsoft",
				"url": "https://en.wikipedia.org/wiki/Microsoft",
				"dataSource": "Wikipedia"
			}, {
				"bingId": "0d47c987-0042-5576-15e8-97af601614fa",
				"name": "Bill Gates",
				"matches": [{
					"text": "Bill Gates",
					"offset": 25,
					"length": 10,
					"confidenceScore": 0.52
				}],
				"language": "en",
				"id": "Bill Gates",
				"url": "https://en.wikipedia.org/wiki/Bill_Gates",
				"dataSource": "Wikipedia"
			}, {
				"bingId": "df2c4376-9923-6a54-893f-2ee5a5badbc7",
				"name": "Paul Allen",
				"matches": [{
					"text": "Paul Allen",
					"offset": 40,
					"length": 10,
					"confidenceScore": 0.54
				}],
				"language": "en",
				"id": "Paul Allen",
				"url": "https://en.wikipedia.org/wiki/Paul_Allen",
				"dataSource": "Wikipedia"
			}, {
				"bingId": "52535f87-235e-b513-54fe-c03e4233ac6e",
				"name": "April 4",
				"matches": [{
					"text": "April 4",
					"offset": 54,
					"length": 7,
					"confidenceScore": 0.38
				}],
				"language": "en",
				"id": "April 4",
				"url": "https://en.wikipedia.org/wiki/April_4",
				"dataSource": "Wikipedia"
			}],
			"warnings": []
		}],
		"errors": [],
		"modelVersion": "2021-06-01"
	}
}

Membersihkan sumber daya

Jika Anda ingin membersihkan dan menghapus langganan layanan Azure AI, Anda dapat menghapus sumber daya atau grup sumber daya. Menghapus grup sumber daya juga menghapus sumber daya apa pun yang terkait dengannya.

Langkah berikutnya