TextAnalysisClient class
Klien untuk berinteraksi dengan fitur analisis teks di Azure Cognitive Language Service.
Klien memerlukan titik akhir sumber daya Bahasa dan metode autentikasi seperti kunci API atau AAD. Kunci API dan titik akhir dapat ditemukan di halaman Sumber daya Bahasa di portal Microsoft Azure. Mereka akan terletak di halaman Kunci dan Titik Akhir sumber daya, di bawah Manajemen Sumber Daya.
Contoh untuk autentikasi:
Kunci API
import { TextAnalysisClient, AzureKeyCredential } from "@azure/ai-language-text";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");
const client = new TextAnalysisClient(endpoint, credential);
Azure Active Directory
Lihat paket @azure/identity untuk informasi selengkapnya tentang mengautentikasi dengan Azure Active Directory.
import { TextAnalysisClient } from "@azure/ai-language-text";
import { DefaultAzureCredential } from "@azure/identity";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();
const client = new TextAnalysisClient(endpoint, credential);
Konstruktor
| Text |
Membuat instans TextAnalysisClient dengan titik akhir sumber daya Bahasa dan metode autentikasi seperti kunci API atau AAD. Kunci API dan titik akhir dapat ditemukan di halaman Sumber daya Bahasa di portal Microsoft Azure. Mereka akan terletak di halaman Kunci dan Titik Akhir sumber daya, di bawah Manajemen Sumber Daya. Contoh
|
| Text |
Membuat instans TextAnalysisClient dengan titik akhir sumber daya Bahasa dan metode autentikasi seperti kunci API atau AAD. Kunci API dan titik akhir dapat ditemukan di halaman Sumber daya Bahasa di portal Microsoft Azure. Mereka akan terletak di halaman Kunci dan Titik Akhir sumber daya, di bawah Manajemen Sumber Daya. ContohLihat paket
|
Metode
| analyze<Action |
Menjalankan model prediktif untuk menentukan bahasa tempat string input yang diteruskan ditulis, dan mengembalikan, untuk masing-masing, bahasa yang terdeteksi serta skor yang menunjukkan keyakinan model bahwa bahasa yang disimpulkan sudah benar. Skor mendekati 1 menunjukkan kepastian tinggi dalam hasilnya. 120 bahasa didukung. Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data. ContohDeteksi bahasa
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview untuk informasi selengkapnya tentang deteksi bahasa. |
| analyze<Action |
Menjalankan model prediktif untuk menentukan bahasa tempat string input yang diteruskan ditulis, dan mengembalikan, untuk masing-masing, bahasa yang terdeteksi serta skor yang menunjukkan keyakinan model bahwa bahasa yang disimpulkan sudah benar. Skor mendekati 1 menunjukkan kepastian tinggi dalam hasilnya. 120 bahasa didukung. Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data. ContohDeteksi bahasa
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview untuk informasi selengkapnya tentang deteksi bahasa. |
| analyze<Action |
Menjalankan model prediktif untuk melakukan tindakan pilihan pada string input. Lihat $AnalyzeActionName untuk daftar tindakan yang didukung. Tata letak setiap item dalam array hasil bergantung pada tindakan yang dipilih.
Misalnya, setiap hasil dokumen PIIEntityRecognition terdiri dari Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data. ContohPenggalian opini
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview untuk informasi selengkapnya tentang penambangan opini. Informasi yang dapat diidentifikasi secara pribadi
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview untuk informasi selengkapnya tentang informasi identitas pribadi. |
| analyze<Action |
Menjalankan model prediktif untuk melakukan tindakan pilihan pada dokumen input. Lihat $AnalyzeActionName untuk daftar tindakan yang didukung. Tata letak setiap item dalam array hasil bergantung pada tindakan yang dipilih.
Misalnya, setiap hasil dokumen PIIEntityRecognition terdiri dari Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data. ContohPenggalian opini
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview untuk informasi selengkapnya tentang penambangan opini. Informasi yang dapat diidentifikasi secara pribadi
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview untuk informasi selengkapnya tentang informasi identitas pribadi. |
| begin |
Melakukan array (batch) tindakan pada dokumen input. Setiap tindakan memiliki bidang Array hasil berisi hasil untuk tindakan input tersebut di mana setiap item juga memiliki bidang Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data. ContohEkstraksi frasa kunci dan pengenalan entitas Pii
|
| begin |
Melakukan array (batch) tindakan pada dokumen input. Setiap tindakan memiliki bidang Array hasil berisi hasil untuk tindakan input tersebut di mana setiap item juga memiliki bidang Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data. ContohEkstraksi frasa kunci dan pengenalan entitas Pii
|
| restore |
Membuat poller dari status serial poller lain. Ini dapat berguna ketika Anda ingin membuat poller pada host yang berbeda atau poller perlu dibangun setelah yang asli tidak berada dalam cakupan. |
Detail Konstruktor
TextAnalysisClient(string, KeyCredential, TextAnalysisClientOptions)
Membuat instans TextAnalysisClient dengan titik akhir sumber daya Bahasa dan metode autentikasi seperti kunci API atau AAD.
Kunci API dan titik akhir dapat ditemukan di halaman Sumber daya Bahasa di portal Microsoft Azure. Mereka akan terletak di halaman Kunci dan Titik Akhir sumber daya, di bawah Manajemen Sumber Daya.
Contoh
import { TextAnalysisClient, AzureKeyCredential } from "@azure/ai-language-text";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");
const client = new TextAnalysisClient(endpoint, credential);
new TextAnalysisClient(endpointUrl: string, credential: KeyCredential, options?: TextAnalysisClientOptions)
Parameter
- endpointUrl
-
string
URL ke titik akhir sumber daya Cognitive Language Service
- credential
- KeyCredential
Kredensial kunci yang akan digunakan untuk mengautentikasi permintaan ke layanan.
- options
- TextAnalysisClientOptions
Digunakan untuk mengonfigurasi klien TextAnalytics.
TextAnalysisClient(string, TokenCredential, TextAnalysisClientOptions)
Membuat instans TextAnalysisClient dengan titik akhir sumber daya Bahasa dan metode autentikasi seperti kunci API atau AAD.
Kunci API dan titik akhir dapat ditemukan di halaman Sumber daya Bahasa di portal Microsoft Azure. Mereka akan terletak di halaman Kunci dan Titik Akhir sumber daya, di bawah Manajemen Sumber Daya.
Contoh
Lihat paket @azure/identity untuk informasi selengkapnya tentang mengautentikasi dengan Azure Active Directory.
import { TextAnalysisClient } from "@azure/ai-language-text";
import { DefaultAzureCredential } from "@azure/identity";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();
const client = new TextAnalysisClient(endpoint, credential);
new TextAnalysisClient(endpointUrl: string, credential: TokenCredential, options?: TextAnalysisClientOptions)
Parameter
- endpointUrl
-
string
URL ke titik akhir sumber daya Cognitive Language Service
- credential
- TokenCredential
Kredensial token yang akan digunakan untuk mengautentikasi permintaan ke layanan.
- options
- TextAnalysisClientOptions
Digunakan untuk mengonfigurasi klien TextAnalytics.
Detail Metode
analyze<ActionName>(ActionName, LanguageDetectionInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Menjalankan model prediktif untuk menentukan bahasa tempat string input yang diteruskan ditulis, dan mengembalikan, untuk masing-masing, bahasa yang terdeteksi serta skor yang menunjukkan keyakinan model bahwa bahasa yang disimpulkan sudah benar. Skor mendekati 1 menunjukkan kepastian tinggi dalam hasilnya. 120 bahasa didukung.
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data.
Contoh
Deteksi bahasa
const documents = [<input strings>];
const countryHint = "us";
const results = await client.analyze("LanguageDetection", documents, countryHint);
for (let i = 0; i < results.length; i++) {
const result = results[i];
if (result.error) {
// a document has an error instead of results
} else {
const { name, confidenceScore, iso6391Name } = result.primaryLanguage;
}
}
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview untuk informasi selengkapnya tentang deteksi bahasa.
function analyze<ActionName>(actionName: ActionName, documents: LanguageDetectionInput[], options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>
Parameter
- actionName
-
ActionName
nama tindakan yang akan dilakukan pada dokumen input, lihat $AnalyzeActionName
- documents
dokumen input yang akan dianalisis
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
parameter dan pengaturan tindakan opsional untuk operasi
Mengembalikan
Promise<AnalyzeResult<ActionName>>
array hasil di mana setiap elemen berisi bahasa utama untuk dokumen input yang sesuai.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Menjalankan model prediktif untuk menentukan bahasa tempat string input yang diteruskan ditulis, dan mengembalikan, untuk masing-masing, bahasa yang terdeteksi serta skor yang menunjukkan keyakinan model bahwa bahasa yang disimpulkan sudah benar. Skor mendekati 1 menunjukkan kepastian tinggi dalam hasilnya. 120 bahasa didukung.
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data.
Contoh
Deteksi bahasa
const documents = [<input strings>];
const countryHint = "us";
const results = await client.analyze("LanguageDetection", documents, countryHint);
for (const result of results) {
if (result.error) {
// a document has an error instead of results
} else {
const { name, confidenceScore, iso6391Name } = result.primaryLanguage;
}
}
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview untuk informasi selengkapnya tentang deteksi bahasa.
function analyze<ActionName>(actionName: ActionName, documents: string[], countryHint?: string, options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>
Parameter
- actionName
-
ActionName
nama tindakan yang akan dilakukan pada dokumen input, lihat $AnalyzeActionName
- documents
-
string[]
dokumen input yang akan dianalisis
- countryHint
-
string
Menunjukkan negara asal untuk semua string input untuk membantu model dalam memprediksi bahasa tempat mereka ditulis. Jika tidak ditentukan, nilai ini akan diatur ke petunjuk negara default di TextAnalysisClientOptions. Jika diatur ke string kosong, atau string "none", layanan akan menerapkan model di mana negara secara eksplisit tidak diatur. Petunjuk negara yang sama diterapkan ke semua string dalam koleksi input.
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
parameter dan pengaturan tindakan opsional untuk operasi
Mengembalikan
Promise<AnalyzeResult<ActionName>>
array hasil di mana setiap elemen berisi bahasa utama untuk dokumen input yang sesuai.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Menjalankan model prediktif untuk melakukan tindakan pilihan pada string input. Lihat $AnalyzeActionName untuk daftar tindakan yang didukung.
Tata letak setiap item dalam array hasil bergantung pada tindakan yang dipilih.
Misalnya, setiap hasil dokumen PIIEntityRecognition terdiri dari entities dan redactedText di mana yang pertama adalah daftar semua entitas Pii dalam teks dan yang terakhir adalah teks asli setelah semua entitas Pii tersebut telah diredaksi darinya.
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data.
Contoh
Penggalian opini
const documents = ["The food and service aren't the best"];
const results = await client.analyze("SentimentAnalysis", documents, {
includeOpinionMining: true,
});
for (const result of results) {
if (result.error) {
// a document has an error instead of results
} else {
const { sentiment, confidenceScores, sentences } = result;
for (const { sentiment, confidenceScores, opinions } of sentences) {
for (const { target, assessments } of opinions) {
const { text, sentiment, confidenceScores } = target;
for (const { text, sentiment } of assessments) {
// Do something
}
}
}
}
}
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview untuk informasi selengkapnya tentang penambangan opini.
Informasi yang dapat diidentifikasi secara pribadi
const documents = [<input strings>];
const languageCode = "en";
const categoriesFilter = [KnownPiiCategory.USSocialSecurityNumber];
const domainFilter = KnownPiiDomain.Phi;
const results = await client.analyze("PiiEntityRecognition", documents, languageCode, {
domainFilter, categoriesFilter
});
for (const result of results) {
if (result.error) {
// a document has an error instead of results
} else {
const { entities, redactedText } = result;
for (const { text, category, confidenceScore, length, offset } of entities) {
// Do something
}
}
}
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview untuk informasi selengkapnya tentang informasi identitas pribadi.
function analyze<ActionName>(actionName: ActionName, documents: string[], languageCode?: string, options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>
Parameter
- actionName
-
ActionName
nama tindakan yang akan dilakukan pada dokumen input, lihat $AnalyzeActionName
- documents
-
string[]
dokumen input yang akan dianalisis
- languageCode
-
string
kode bahasa tempat semua string input ditulis. Jika tidak ditentukan, nilai ini akan diatur ke bahasa default dalam TextAnalysisClientOptions. Jika diatur ke string kosong, layanan akan menerapkan model di mana bahasa secara eksplisit diatur ke "Tidak Ada". Dukungan bahasa bervariasi per tindakan, misalnya, informasi selengkapnya tentang bahasa yang didukung untuk tindakan Pengenalan Entitas dapat ditemukan di https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support.
Jika diatur ke "otomatis", layanan akan secara otomatis menyimpulkan bahasa dari teks input.
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
parameter dan pengaturan tindakan opsional untuk operasi
Mengembalikan
Promise<AnalyzeResult<ActionName>>
array hasil yang sesuai dengan dokumen input
analyze<ActionName>(ActionName, TextDocumentInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Menjalankan model prediktif untuk melakukan tindakan pilihan pada dokumen input. Lihat $AnalyzeActionName untuk daftar tindakan yang didukung.
Tata letak setiap item dalam array hasil bergantung pada tindakan yang dipilih.
Misalnya, setiap hasil dokumen PIIEntityRecognition terdiri dari entities dan redactedText di mana yang pertama adalah daftar semua entitas Pii dalam teks dan yang terakhir adalah teks asli setelah semua entitas Pii tersebut telah diredaksi darinya.
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data.
Contoh
Penggalian opini
const documents = [{
id: "1",
text: "The food and service aren't the best",
language: "en"
}];
const results = await client.analyze("SentimentAnalysis", documents, {
includeOpinionMining: true,
});
for (const result of results) {
if (result.error) {
// a document has an error instead of results
} else {
const { sentiment, confidenceScores, sentences } = result;
for (const { sentiment, confidenceScores, opinions } of sentences) {
for (const { target, assessments } of opinions) {
const { text, sentiment, confidenceScores } = target;
for (const { text, sentiment } of assessments) {
// Do something
}
}
}
}
}
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview untuk informasi selengkapnya tentang penambangan opini.
Informasi yang dapat diidentifikasi secara pribadi
const documents = [<input documents>];
const categoriesFilter = [KnownPiiCategory.USSocialSecurityNumber];
const domainFilter = KnownPiiDomain.Phi;
const results = await client.analyze("PiiEntityRecognition", documents, {
domainFilter, categoriesFilter
});
for (const result of results) {
if (result.error) {
// a document has an error instead of results
} else {
const { entities, redactedText } = result;
for (const { text, category, confidenceScore, length, offset } of entities) {
// Do something
}
}
}
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview untuk informasi selengkapnya tentang informasi identitas pribadi.
function analyze<ActionName>(actionName: ActionName, documents: TextDocumentInput[], options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>
Parameter
- actionName
-
ActionName
nama tindakan yang akan dilakukan pada dokumen input, lihat $AnalyzeActionName
- documents
dokumen input yang akan dianalisis
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
parameter dan pengaturan tindakan opsional untuk operasi
Mengembalikan
Promise<AnalyzeResult<ActionName>>
array hasil yang sesuai dengan dokumen input
beginAnalyzeBatch(AnalyzeBatchAction[], string[], string, BeginAnalyzeBatchOptions)
Melakukan array (batch) tindakan pada dokumen input. Setiap tindakan memiliki bidang kind yang menentukan sifat tindakan. Lihat $AnalyzeBatchActionNames untuk daftar tindakan yang didukung. Selain kind, tindakan juga dapat memiliki parameter lain seperti disableServiceLogs dan modelVersion.
Array hasil berisi hasil untuk tindakan input tersebut di mana setiap item juga memiliki bidang kind yang menentukan jenis hasilnya.
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data.
Contoh
Ekstraksi frasa kunci dan pengenalan entitas Pii
const poller = await client.beginAnalyzeBatch(
[{ kind: "KeyPhraseExtraction" }, { kind: "PiiEntityRecognition" }],
documents
);
const actionResults = await poller.pollUntilDone();
for await (const actionResult of actionResults) {
if (actionResult.error) {
throw new Error(`Unexpected error`);
}
switch (actionResult.kind) {
case "KeyPhraseExtraction": {
for (const doc of actionResult.results) {
// do something
}
break;
}
case "PiiEntityRecognition": {
for (const doc of actionResult.results) {
// do something
}
break;
}
}
}
function beginAnalyzeBatch(actions: AnalyzeBatchAction[], documents: string[], languageCode?: string, options?: BeginAnalyzeBatchOptions): Promise<AnalyzeBatchPoller>
Parameter
- actions
array tindakan yang akan dijalankan pada dokumen input
- documents
-
string[]
dokumen input yang akan dianalisis
- languageCode
-
string
kode bahasa tempat semua string input ditulis. Jika tidak ditentukan, nilai ini akan diatur ke bahasa default dalam TextAnalysisClientOptions. Jika diatur ke string kosong, layanan akan menerapkan model di mana bahasa secara eksplisit diatur ke "Tidak Ada". Dukungan bahasa bervariasi per tindakan, misalnya, informasi selengkapnya tentang bahasa yang didukung untuk tindakan Pengenalan Entitas dapat ditemukan di https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support.
Jika diatur ke "otomatis", layanan akan secara otomatis menyimpulkan bahasa dari teks input.
- options
- BeginAnalyzeBatchOptions
pengaturan opsional untuk operasi
Mengembalikan
Promise<AnalyzeBatchPoller>
array hasil yang sesuai dengan tindakan input
beginAnalyzeBatch(AnalyzeBatchAction[], TextDocumentInput[], BeginAnalyzeBatchOptions)
Melakukan array (batch) tindakan pada dokumen input. Setiap tindakan memiliki bidang kind yang menentukan sifat tindakan. Lihat $AnalyzeBatchActionNames untuk daftar tindakan yang didukung. Selain kind, tindakan juga dapat memiliki parameter lain seperti disableServiceLogs dan modelVersion.
Array hasil berisi hasil untuk tindakan input tersebut di mana setiap item juga memiliki bidang kind yang menentukan jenis hasilnya.
Lihat https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits untuk batas data.
Contoh
Ekstraksi frasa kunci dan pengenalan entitas Pii
const poller = await client.beginAnalyzeBatch(
[{ kind: "KeyPhraseExtraction" }, { kind: "PiiEntityRecognition" }],
documents
);
const actionResults = await poller.pollUntilDone();
for await (const actionResult of actionResults) {
if (actionResult.error) {
throw new Error(`Unexpected error`);
}
switch (actionResult.kind) {
case "KeyPhraseExtraction": {
for (const doc of actionResult.results) {
// do something
}
break;
}
case "PiiEntityRecognition": {
for (const doc of actionResult.results) {
// do something
}
break;
}
}
}
function beginAnalyzeBatch(actions: AnalyzeBatchAction[], documents: TextDocumentInput[], options?: BeginAnalyzeBatchOptions): Promise<AnalyzeBatchPoller>
Parameter
- actions
array tindakan yang akan dijalankan pada dokumen input
- documents
dokumen input yang akan dianalisis
- options
- BeginAnalyzeBatchOptions
pengaturan opsional untuk operasi
Mengembalikan
Promise<AnalyzeBatchPoller>
array hasil yang sesuai dengan tindakan input
restoreAnalyzeBatchPoller(string, RestoreAnalyzeBatchPollerOptions)
Membuat poller dari status serial poller lain. Ini dapat berguna ketika Anda ingin membuat poller pada host yang berbeda atau poller perlu dibangun setelah yang asli tidak berada dalam cakupan.
function restoreAnalyzeBatchPoller(serializedState: string, options?: RestoreAnalyzeBatchPollerOptions): Promise<AnalyzeBatchPoller>
Parameter
- serializedState
-
string
status serial poller lain. Ini adalah hasil dari poller.toString()
- options
- RestoreAnalyzeBatchPollerOptions
pengaturan opsional untuk operasi
Contoh
client.beginAnalyzeBatch mengembalikan janji yang akan diselesaikan ke poller.
Status poller dapat diserialisasikan dan digunakan untuk membuat yang lain sebagai berikut:
const serializedState = poller.toString();
const rehydratedPoller = await client.createAnalyzeBatchPoller(serializedState);
const actionResults = await rehydratedPoller.pollUntilDone();
Mengembalikan
Promise<AnalyzeBatchPoller>