Pustaka klien Azure Text Analytics untuk JavaScript - versi 5.1.0

Artikel
04/05/2023

Azure TextAnalytics adalah layanan berbasis cloud yang menyediakan pemrosesan bahasa alami tingkat lanjut melalui teks mentah, dan mencakup enam fungsi utama:

Catatan: SDK ini menargetkan API layanan Azure Text Analytics versi 3.1.0.

Deteksi Bahasa
Analisis Sentimen
Ekstraksi Frasa Kunci
Pengenalan Entitas
Pengenalan Informasi Pengidentifikasi Pribadi
Pengenalan Entitas Tertaut
Analisis Layanan Kesehatan
Mendukung Beberapa Tindakan Per Dokumen

Gunakan pustaka klien untuk:

Deteksi teks input bahasa apa yang ditulis.
Tentukan pendapat pelanggan tentang merek atau topik Anda dengan menganalisis teks mentah untuk petunjuk tentang sentimen positif atau negatif.
Ekstrak frasa kunci secara otomatis untuk mengidentifikasi poin utama dengan cepat.
Identifikasi dan kategorikan entitas dalam teks Anda sebagai orang, tempat, organisasi, tanggal/waktu, jumlah, persentase, mata uang, spesifik layanan kesehatan, dan banyak lagi.
Lakukan beberapa tugas di atas sekaligus.

Tautan utama:

Memulai

Lingkungan yang didukung saat ini

Versi LTS dari Node.js
Safari, Chrome, Edge, dan Firefox versi terbaru.

Lihat kebijakan dukungan kami untuk detail selengkapnya.

Prasyarat

Langganan Azure.
Sumber daya Cognitive Services atau Text Analytics yang ada. Jika Anda perlu membuat sumber daya, Anda dapat menggunakan Portal Microsoft Azure atau Azure CLI.

Jika Anda menggunakan Azure CLI, ganti <your-resource-group-name> dan <your-resource-name> dengan nama unik Anda sendiri:

az cognitiveservices account create --kind TextAnalytics --resource-group <your-resource-group-name> --name <your-resource-name> --sku <your-sku-name> --location <your-location>

Pasang paket `@azure/ai-text-analytics`

Instal pustaka klien Azure Text Analytics untuk JavaScript dengan npm:

npm install @azure/ai-text-analytics

Membuat dan mengautentikasi `TextAnalyticsClient`

Untuk membuat objek klien untuk mengakses Text Analytics API, Anda memerlukan endpoint sumber daya Text Analytics dan credential. Klien Text Analytics dapat menggunakan kredensial Azure Active Directory atau kredensial kunci API untuk mengautentikasi.

Anda dapat menemukan titik akhir untuk sumber daya analitik teks Anda baik di Portal Microsoft Azure atau dengan menggunakan cuplikan Azure CLI di bawah ini:

az cognitiveservices account show --name <your-resource-name> --resource-group <your-resource-group-name> --query "endpoint"

Menggunakan Kunci API

Gunakan Portal Microsoft Azure untuk menelusuri ke sumber daya Text Analytics Anda dan mengambil kunci API, atau gunakan cuplikan Azure CLI di bawah ini:

Catatan: Terkadang kunci API disebut sebagai "kunci langganan" atau "kunci API langganan."

az cognitiveservices account keys list --resource-group <your-resource-group-name> --name <your-resource-name>

Setelah Anda memiliki kunci API dan titik akhir, Anda dapat menggunakan AzureKeyCredential kelas untuk mengautentikasi klien sebagai berikut:

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

const client = new TextAnalyticsClient("<endpoint>", new AzureKeyCredential("<API key>"));

Menggunakan Kredensial Azure Active Directory

Autentikasi kunci API klien digunakan di sebagian besar contoh, tetapi Anda juga dapat mengautentikasi dengan Azure Active Directory menggunakan pustaka Azure Identity. Untuk menggunakan penyedia DefaultAzureCredential yang ditunjukkan di bawah ini, atau penyedia kredensial lain yang disediakan dengan Azure SDK, harap instal @azure/identity paket:

npm install @azure/identity

Anda juga perlu mendaftarkan aplikasi AAD baru dan memberikan akses ke Text Analytics dengan menetapkan "Cognitive Services User" peran ke perwakilan layanan Anda (catatan: peran lain seperti "Owner" tidak akan memberikan izin yang diperlukan, hanya "Cognitive Services User" cukup untuk menjalankan contoh dan kode sampel).

Atur nilai ID klien, ID penyewa, dan rahasia klien aplikasi AAD sebagai variabel lingkungan: AZURE_CLIENT_ID, , AZURE_TENANT_IDAZURE_CLIENT_SECRET.

const { TextAnalyticsClient } = require("@azure/ai-text-analytics");
const { DefaultAzureCredential } = require("@azure/identity");

const client = new TextAnalyticsClient("<endpoint>", new DefaultAzureCredential());

Konsep utama

TextAnalyticsClient

TextAnalyticsClient adalah antarmuka utama untuk pengembang yang menggunakan pustaka klien Text Analytics. Jelajahi metode pada objek klien ini untuk memahami berbagai fitur layanan Text Analytics yang dapat Anda akses.

Input

Dokumen mewakili satu unit input yang akan dianalisis oleh model prediktif di layanan Text Analytics. Operasi pada TextAnalyticsClient mengambil kumpulan input untuk dianalisis sebagai batch. Metode operasi memiliki kelebihan beban yang memungkinkan input direpresentasikan sebagai string, atau sebagai objek dengan metadata terlampir.

Misalnya, setiap dokumen dapat diteruskan sebagai string dalam array, misalnya

const documents = [
  "I hated the movie. It was so slow!",
  "The movie made it into my top ten favorites.",
  "What a great movie!"
];

atau, jika Anda ingin meneruskan dokumen id per item atau languagecountryHint/, dokumen tersebut dapat diberikan sebagai daftar TextDocumentInput atau DetectLanguageInput tergantung pada operasi;

const textDocumentInputs = [
  { id: "1", language: "en", text: "I hated the movie. It was so slow!" },
  { id: "2", language: "en", text: "The movie made it into my top ten favorites." },
  { id: "3", language: "en", text: "What a great movie!" }
];

Lihat batasan layanan untuk input, termasuk batas panjang dokumen, ukuran batch maksimum, dan pengodean teks yang didukung.

Tampilkan Nilai

Nilai yang dikembalikan yang terkait dengan satu dokumen adalah hasil yang berhasil atau objek kesalahan. Setiap TextAnalyticsClient metode mengembalikan array hasil dan kesalahan heterogen yang sesuai dengan input menurut indeks. Input teks dan hasilnya akan memiliki indeks yang sama dalam kumpulan input dan hasil. Koleksi juga dapat secara opsional menyertakan informasi tentang batch input dan bagaimana diproses di statistics bidang .

Hasilnya, seperti AnalyzeSentimentResult, adalah hasil dari operasi Text Analytics, yang berisi prediksi atau prediksi tentang input teks tunggal. Jenis hasil operasi juga dapat secara opsional menyertakan informasi tentang dokumen input dan cara pemrosesannya.

Objek kesalahan , TextAnalyticsErrorResult, menunjukkan bahwa layanan mengalami kesalahan saat memproses dokumen dan berisi informasi tentang kesalahan.

Penanganan Kesalahan Dokumen

Dalam koleksi yang dikembalikan oleh operasi, kesalahan dibedakan dari respons yang berhasil dengan keberadaan error properti , yang berisi objek dalam TextAnalyticsError jika terjadi kesalahan. Untuk objek hasil yang berhasil, properti ini selaluundefined.

Misalnya, untuk memfilter semua kesalahan, Anda dapat menggunakan yang berikut:filter

const results = await client.analyzeSentiment(documents);
const onlySuccessful = results.filter((result) => result.error === undefined);

Catatan: Pengguna TypeScript dapat memperoleh manfaat dari pemeriksaan jenis objek hasil dan kesalahan yang lebih baik jika compilerOptions.strictNullChecks diatur ke truetsconfig.json dalam konfigurasi. Contohnya:

const [result] = await client.analyzeSentiment(["Hello world!"]);

if (result.error !== undefined) {
  // In this if block, TypeScript will be sure that the type of `result` is
  // `TextAnalyticsError` if compilerOptions.strictNullChecks is enabled in
  // the tsconfig.json

  console.log(result.error);
}

Kemampuan ini diperkenalkan dalam TypeScript 3.2, sehingga pengguna TypeScript 3.1 harus melemparkan nilai hasil ke varian keberhasilan yang sesuai sebagai berikut:

const [result] = await client.detectLanguage(["Hello world!"]);

if (result.error === undefined) {
  const { primaryLanguage } = result as DetectLanguageSuccessResult;
}

Contoh

Menganalisis Sentimen

Analisis sentimen teks untuk menentukan apakah itu positif, negatif, netral, atau campuran, termasuk analisis sentimen per kalimat dan skor keyakinan.

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

const client = new TextAnalyticsClient("<endpoint>", new AzureKeyCredential("<API key>"));

const documents = [
  "I did not like the restaurant. The food was too spicy.",
  "The restaurant was decorated beautifully. The atmosphere was unlike any other restaurant I've been to.",
  "The food was yummy. :)"
];

async function main() {
  const results = await client.analyzeSentiment(documents);

  for (const result of results) {
    if (result.error === undefined) {
      console.log("Overall sentiment:", result.sentiment);
      console.log("Scores:", result.confidenceScores);
    } else {
      console.error("Encountered an error:", result.error);
    }
  }
}

main();

Untuk mendapatkan informasi yang lebih terperinci tentang pendapat yang terkait dengan aspek produk/layanan, juga dikenal sebagai Analisis Sentimen Berbasis Aspek dalam Pemrosesan Bahasa Alami (NLP), lihat sampel analisis sentimen dengan penambangan opini di sini.

Mengenali Entitas

Mengenali dan mengategorikan entitas dalam teks sebagai orang, tempat, organisasi, tanggal/waktu, jumlah, mata uang, dll.

Parameter language bersifat opsional. Jika tidak ditentukan, model bahasa Inggris default akan digunakan.

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

const client = new TextAnalyticsClient("<endpoint>", new AzureKeyCredential("<API key>"));

const documents = [
  "Microsoft was founded by Bill Gates and Paul Allen.",
  "Redmond is a city in King County, Washington, United States, located 15 miles east of Seattle.",
  "Jeff bought three dozen eggs because there was a 50% discount."
];

async function main() {
  const results = await client.recognizeEntities(documents, "en");

  for (const result of results) {
    if (result.error === undefined) {
      console.log(" -- Recognized entities for input", result.id, "--");
      for (const entity of result.entities) {
        console.log(entity.text, ":", entity.category, "(Score:", entity.confidenceScore, ")");
      }
    } else {
      console.error("Encountered an error:", result.error);
    }
  }
}

main();

Mengenali Entitas PII

Ada titik akhir dan operasi terpisah untuk mengenali Informasi Pengidentifikasi Pribadi (PII) dalam teks seperti Nomor Jaminan Sosial, informasi rekening bank, nomor kartu kredit, dll. Penggunaannya sangat mirip dengan pengenalan entitas standar di atas:

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");
const client = new TextAnalyticsClient("<endpoint>", new AzureKeyCredential("<API key>"));
const documents = [
  "The employee's SSN is 555-55-5555.",
  "The employee's phone number is (555) 555-5555."
];
async function main() {
  const results = await client.recognizePiiEntities(documents, "en");
  for (const result of results) {
    if (result.error === undefined) {
      console.log(" -- Recognized PII entities for input", result.id, "--");
      for (const entity of result.entities) {
        console.log(entity.text, ":", entity.category, "(Score:", entity.confidenceScore, ")");
      }
    } else {
      console.error("Encountered an error:", result.error);
    }
  }
}
main();

Mengenali Entitas Tertaut

Entitas "Tertaut" adalah entitas yang ada dalam Pangkalan Pengetahuan (seperti Wikipedia). Operasi ini recognizeLinkedEntities dapat membedakan entitas dengan menentukan entri mana dalam Pangkalan Pengetahuan yang kemungkinan mereka rujuk (misalnya, dalam sepotong teks, apakah kata "Mars" mengacu pada planet, atau dewa perang Romawi). Entitas tertaut berisi URL terkait ke Pangkalan Pengetahuan yang menyediakan definisi entitas.

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

const client = new TextAnalyticsClient("<endpoint>", new AzureKeyCredential("<API key>"));

const documents = [
  "Microsoft was founded by Bill Gates and Paul Allen.",
  "Easter Island, a Chilean territory, is a remote volcanic island in Polynesia.",
  "I use Azure Functions to develop my product."
];

async function main() {
  const results = await client.recognizeLinkedEntities(documents, "en");

  for (const result of results) {
    if (result.error === undefined) {
      console.log(" -- Recognized linked entities for input", result.id, "--");
      for (const entity of result.entities) {
        console.log(entity.name, "(URL:", entity.url, ", Source:", entity.dataSource, ")");
        for (const match of entity.matches) {
          console.log(
            "  Occurrence:",
            '"' + match.text + '"',
            "(Score:",
            match.confidenceScore,
            ")"
          );
        }
      }
    } else {
      console.error("Encountered an error:", result.error);
    }
  }
}

main();

Ekstrak Frasa Kunci

Ekstraksi Frasa Kunci mengidentifikasi poin pembicaraan utama dalam dokumen. Misalnya, diberi teks input "Makanannya lezat dan ada staf yang luar biasa", layanan mengembalikan "makanan" dan "staf yang luar biasa".

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

const client = new TextAnalyticsClient("<endpoint>", new AzureKeyCredential("<API key>"));

const documents = [
  "Redmond is a city in King County, Washington, United States, located 15 miles east of Seattle.",
  "I need to take my cat to the veterinarian.",
  "I will travel to South America in the summer."
];

async function main() {
  const results = await client.extractKeyPhrases(documents, "en");

  for (const result of results) {
    if (result.error === undefined) {
      console.log(" -- Extracted key phrases for input", result.id, "--");
      console.log(result.keyPhrases);
    } else {
      console.error("Encountered an error:", result.error);
    }
  }
}

main();

Mendeteksi Bahasa

Tentukan bahasa sepotong teks.

Parameter countryHint bersifat opsional, tetapi dapat membantu layanan dalam memberikan output yang benar jika negara asal diketahui. Jika disediakan, kode negara dua huruf ISO-3166 Alpha-2 harus diatur ke ISO-3166 Alpha-2 (seperti "kami" untuk Amerika Serikat atau "jp" untuk Jepang) atau ke nilai "none". Jika parameter tidak disediakan, model default "us" (Amerika Serikat) akan digunakan. Jika Anda tidak mengetahui negara asal dokumen, parameter "none" harus digunakan, dan layanan Text Analytics akan menerapkan model yang disetel untuk negara asal yang tidak diketahui.

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

const client = new TextAnalyticsClient("<endpoint>", new AzureKeyCredential("<API key>"));

const documents = [
  "This is written in English.",
  "Il documento scritto in italiano.",
  "Dies ist in deutscher Sprache verfasst."
];

async function main() {
  const results = await client.detectLanguage(documents, "none");

  for (const result of results) {
    if (result.error === undefined) {
      const { primaryLanguage } = result;
      console.log(
        "Input #",
        result.id,
        "identified as",
        primaryLanguage.name,
        "( ISO6391:",
        primaryLanguage.iso6391Name,
        ", Score:",
        primaryLanguage.confidenceScore,
        ")"
      );
    } else {
      console.error("Encountered an error:", result.error);
    }
  }
}

main();

Menganalisis Entitas Layanan Kesehatan

Analisis layanan kesehatan mengidentifikasi entitas layanan kesehatan. Misalnya, diberi teks input "Ditentukan 100mg ibuprofen, diambil dua kali sehari", layanan mengembalikan "100mg" dikategorikan sebagai Dosis, "ibuprofen" sebagai MedicationName, dan "dua kali sehari" sebagai Frekuensi.

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

const client = new TextAnalyticsClient("<endpoint>", new AzureKeyCredential("<API key>"));

const documents = [
  "Prescribed 100mg ibuprofen, taken twice daily.",
  "Patient does not suffer from high blood pressure."
];

async function main() {
  const poller = await client.beginAnalyzeHealthcareEntities(documents);
  const results = await poller.pollUntilDone();

  for await (const result of results) {
    console.log(`- Document ${result.id}`);
    if (!result.error) {
      console.log("\tRecognized Entities:");
      for (const entity of result.entities) {
        console.log(`\t- Entity ${entity.text} of type ${entity.category}`);
      }
    } else console.error("\tError:", result.error);
  }
}

main();

Analisis Tindakan

Menganalisis tindakan memungkinkan penerapan beberapa analisis (tindakan bernama) sekaligus.

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

const client = new TextAnalyticsClient("<endpoint>", new AzureKeyCredential("<API key>"));

const documents = [
  "Microsoft was founded by Bill Gates and Paul Allen.",
  "The employee's SSN is 555-55-5555.",
  "Easter Island, a Chilean territory, is a remote volcanic island in Polynesia.",
  "I use Azure Functions to develop my product."
];

async function main() {
  const actions = {
    recognizeEntitiesActions: [{ modelVersion: "latest" }],
    recognizePiiEntitiesActions: [{ modelVersion: "latest" }],
    extractKeyPhrasesActions: [{ modelVersion: "latest" }]
  };
  const poller = await client.beginAnalyzeActions(documents, actions);
  const resultPages = await poller.pollUntilDone();
  for await (const page of resultPages) {
    const keyPhrasesAction = page.extractKeyPhrasesResults[0];
    if (!keyPhrasesAction.error) {
      for (const doc of keyPhrasesAction.results) {
        console.log(`- Document ${doc.id}`);
        if (!doc.error) {
          console.log("\tKey phrases:");
          for (const phrase of doc.keyPhrases) {
            console.log(`\t- ${phrase}`);
          }
        } else {
          console.error("\tError:", doc.error);
        }
      }
    }

    const entitiesAction = page.recognizeEntitiesResults[0];
    if (!entitiesAction.error) {
      for (const doc of entitiesAction.results) {
        console.log(`- Document ${doc.id}`);
        if (!doc.error) {
          console.log("\tEntities:");
          for (const entity of doc.entities) {
            console.log(`\t- Entity ${entity.text} of type ${entity.category}`);
          }
        } else {
          console.error("\tError:", doc.error);
        }
      }
    }

    const piiEntitiesAction = page.recognizePiiEntitiesResults[0];
    if (!piiEntitiesAction.error) {
      for (const doc of piiEntitiesAction.results) {
        console.log(`- Document ${doc.id}`);
        if (!doc.error) {
          console.log("\tPii Entities:");
          for (const entity of doc.entities) {
            console.log(`\t- Entity ${entity.text} of type ${entity.category}`);
          }
        } else {
          console.error("\tError:", doc.error);
        }
      }
    }
  }
}

main();

Pemecahan Masalah

Pencatatan

Mengaktifkan pengelogan dapat membantu menemukan informasi yang berguna tentang kegagalan. Untuk melihat log permintaan dan respons HTTP, atur variabel lingkungan AZURE_LOG_LEVEL ke info. Atau, pengelogan dapat diaktifkan saat runtime dengan memanggil setLogLevel di @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Untuk instruksi lebih rinci tentang cara mengaktifkan log, Anda dapat melihat dokumen paket @azure/pencatat.

Langkah berikutnya

Silakan lihat direktori sampel untuk contoh terperinci tentang cara menggunakan pustaka ini.

Berkontribusi

Jika Anda ingin berkontribusi pada pustaka ini, baca panduan berkontribusi untuk mempelajari selengkapnya tentang cara membuat dan menguji kode.

Microsoft Azure SDK untuk JavaScript

Tayangan

Pustaka klien Azure Text Analytics untuk JavaScript - versi 5.1.0

Memulai

Lingkungan yang didukung saat ini

Prasyarat

Pasang paket `@azure/ai-text-analytics`

Membuat dan mengautentikasi `TextAnalyticsClient`

Menggunakan Kunci API

Menggunakan Kredensial Azure Active Directory

Konsep utama

TextAnalyticsClient

Input

Tampilkan Nilai

Penanganan Kesalahan Dokumen

Contoh

Menganalisis Sentimen

Mengenali Entitas

Mengenali Entitas PII

Mengenali Entitas Tertaut

Ekstrak Frasa Kunci

Mendeteksi Bahasa

Menganalisis Entitas Layanan Kesehatan

Analisis Tindakan

Pemecahan Masalah

Pencatatan

Langkah berikutnya

Berkontribusi

Saran dan Komentar

Sumber Daya Tambahan:

Pustaka klien Azure Text Analytics untuk JavaScript - versi 5.1.0

Memulai

Lingkungan yang didukung saat ini

Prasyarat

Pasang paket @azure/ai-text-analytics

Membuat dan mengautentikasi TextAnalyticsClient

Menggunakan Kunci API

Menggunakan Kredensial Azure Active Directory

Konsep utama

TextAnalyticsClient

Input

Tampilkan Nilai

Penanganan Kesalahan Dokumen

Contoh

Menganalisis Sentimen

Mengenali Entitas

Mengenali Entitas PII

Mengenali Entitas Tertaut

Ekstrak Frasa Kunci

Mendeteksi Bahasa

Menganalisis Entitas Layanan Kesehatan

Analisis Tindakan

Pemecahan Masalah

Pencatatan

Langkah berikutnya

Berkontribusi

Proyek terkait

Saran dan Komentar

Sumber Daya Tambahan:

Pasang paket `@azure/ai-text-analytics`

Membuat dan mengautentikasi `TextAnalyticsClient`