@azure/ai-text-analytics package

Kredensial berbasis kunci statis yang mendukung pembaruan nilai kunci yang mendasar.

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

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-text-analytics";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new TextAnalysisClient(endpoint, credential);

Konfigurasi umum untuk semua tindakan.

Metadata tindakan.

Opsi umum untuk semua tindakan batch.

Metadata untuk operasi jangka panjang dimulai oleh beginAnalyzeBatch.

Status mulai menganalisis operasi polling.

Objek yang berisi sentimen yang diprediksi, skor keyakinan, dan informasi lainnya tentang penilaian target. Misalnya, dalam kalimat "Makanannya enak", penilaian target 'makanan' adalah 'baik'.

Kesalahan tindakan analisis batch.

Status tindakan yang di-batch

Status tindakan batch yang berhasil.

Opsi untuk mulai menganalisis operasi tindakan.

Hasil klasifikasi dari tindakan kategori tunggal dokumen klasifikasi kustom

Metadata tindakan kustom.

Opsi untuk tindakan batch pengenalan entitas kustom.

Hasil dari operasi kenali entitas kustom pada satu dokumen, berisi kumpulan entitas yang diidentifikasi dalam dokumen tersebut.

Opsi untuk tindakan batch klasifikasi multi-label kustom.

Hasil operasi mengklasifikasikan dokumen multi kategori kustom pada multi dokumen, yang berisi hasil klasifikasi.

Opsi untuk tindakan batch klasifikasi label tunggal kustom.

Hasil operasi kategori tunggal dokumen klasifikasi kustom pada satu dokumen, yang berisi hasil klasifikasi.

Informasi tentang bahasa dokumen seperti yang diidentifikasi oleh layanan Bahasa.

Mewakili peringatan yang ditemui saat memproses dokumen.

Kata atau frasa yang diidentifikasi sebagai entitas yang dikategorikan dalam taksonomi jenis. Kumpulan kategori yang dikenali oleh layanan Bahasa dijelaskan di https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories .

Jenis yang mewakili referensi untuk entitas layanan kesehatan ke dalam katalog entitas tertentu.

Opsi untuk tindakan batch penautan entitas.

Hasil tindakan penautan entitas pada satu dokumen, berisi kumpulan objek LinkedEntity yang diidentifikasi dalam dokumen tersebut.

Opsi untuk tindakan batch pengenalan entitas.

Hasil tindakan pengenalan entitas pada satu dokumen, yang berisi kumpulan objek Entitas yang diidentifikasi dalam dokumen tersebut.

Opsi untuk tindakan batch ringkasan ekstraktif.

Objek yang menjelaskan metadata tentang entitas layanan kesehatan seperti apakah itu hipotetis atau bersyariah.

Opsi untuk tindakan batch layanan kesehatan.

Entitas layanan kesehatan yang direpresentasikan sebagai simpul dalam grafik yang diarahkan di mana tepi adalah jenis hubungan tertentu antara simpul sumber dan target.

Hubungan antara dua atau beberapa entitas layanan kesehatan.

Entitas layanan kesehatan yang memainkan peran tertentu dalam hubungan.

Hasil operasi layanan kesehatan yang berhasil untuk satu dokumen.

Opsi untuk tindakan batch ekstraksi frasa kunci.

Hasil tindakan ekstraksi frasa kunci pada satu dokumen, berisi kumpulan frasa kunci yang diidentifikasi dalam dokumen tersebut.

Input ke operasi deteksi bahasa. Objek ini menentukan id dokumen unik, serta teks lengkap dokumen dan petunjuk yang menunjukkan negara asal dokumen untuk membantu model prediktif bahasa dalam mendeteksi bahasa dokumen.

Hasil tindakan deteksi bahasa pada satu dokumen, berisi prediksi bahasa apa dokumen ditulis.

Kata atau frasa yang diidentifikasi sebagai entitas terkenal dalam database, termasuk nama formal (disambiguasi) dan tautan ke informasi entitas dalam database sumber.

Detail tentang substring tertentu dalam dokumen yang mengacu pada entitas tertaut yang diidentifikasi oleh Model bahasa.

Objek opini yang ditambang mewakili pendapat yang telah kita ekstrak dari kalimat. Ini terdiri dari target yang menjadi dasar penilaian ini, dan penilaian aktual itu sendiri.

Opsi untuk tindakan batch pengenalan entitas pii.

Hasil tindakan pengenalan entitas pii pada satu dokumen, yang berisi kumpulan objek Entitas yang diidentifikasi dalam dokumen tersebut.

Opsi untuk mulai menganalisis operasi tindakan.

Sentimen yang diprediksi untuk rentang teks tertentu. Untuk informasi selengkapnya tentang sentimen teks, lihat https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Opsi untuk tindakan batch analisis sentimen.

Hasil tindakan analisis sentimen pada satu dokumen, yang berisi sentimen yang diprediksi untuk setiap kalimat serta untuk dokumen lengkap.

Mewakili skor keyakinan antara 0 dan 1 di semua kelas sentimen: positif, netral, negatif.

Hasil tindakan ekstraksi ringkasan pada satu dokumen, berisi kumpulan ringkasan yang diidentifikasi dalam dokumen tersebut.

Kalimat yang merupakan bagian dari ringkasan yang diekstrak.

Mewakili skor keyakinan di semua kelas sentimen: positif, netral, negatif.

TargetSentiment berisi sentimen yang diprediksi, skor keyakinan, dan informasi lainnya tentang target produk. Target produk/layanan adalah komponen utama dari produk/layanan tersebut. Misalnya dalam "Makanan di Hotel Foo enak", "makanan" adalah target "Hotel Foo".

Opsi konfigurasi untuk TextAnalysisClient.

Ketik yang menjelaskan kesalahan API.

Jenis dasar untuk hasil kesalahan tindakan yang sesuai dengan satu dokumen.

Opsi umum untuk semua operasi.

Jenis dasar untuk hasil tindakan yang sesuai dengan satu dokumen input.

jika includeStatistics=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload permintaan.

Objek yang mewakili dokumen teks individual untuk dianalisis oleh layanan Bahasa. Dokumen berisi ID dokumen unik, teks lengkap dokumen, dan bahasa teks dokumen.

jika includeStatistics=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload dokumen.

Objek parameter untuk tugas analisis teks menggunakan model kustom.

Konfigurasi umum untuk semua tindakan yang menggunakan model bawaan.

Jenis tindakan yang didukung oleh metode analisis.

Jenis parameter untuk setiap tindakan dalam $AnalyzeActionNames.

Batch tindakan.

Jenis tindakan yang didukung oleh metode beginAnalyzeBatch.

Polling yang melakukan polling operasi jangka panjang dimulai oleh beginAnalyzeBatch.

Hasil batch tindakan.

Jenis hasil setiap tindakan dalam $AnalyzeActionNames.

Hasil dari tindakan batch.

Parameter yang didukung untuk tugas Entitas Kustom.

Hasil tindakan batch pengenalan entitas kustom.

Kesalahan akibat operasi kenali entitas kustom pada satu dokumen.

Hasil operasi kenali entitas kustom pada satu dokumen.

Opsi untuk tindakan kustom klasifikasi multi-label

Hasil dari tindakan batch klasifikasi multi-label kustom.

Hasil kesalahan dari operasi klasifikasi dokumen multikategori kustom pada multi dokumen.

Hasil operasi mengklasifikasikan dokumen multi kategori kustom pada multi dokumen.

Opsi untuk tindakan kustom klasifikasi label tunggal

Hasil dari tindakan batch klasifikasi label tunggal kustom.

Hasil kesalahan dari operasi kategori tunggal dokumen klasifikasi kustom pada satu dokumen.

Hasil operasi kategori tunggal dokumen klasifikasi kustom pada satu dokumen.

Menentukan nilai untuk DocumentSentimentLabel.

Menentukan nilai untuk EntityAssociation.

Menentukan nilai untuk EntityCertainty.

Menentukan nilai untuk EntityConditionality.

Opsi untuk tindakan penautan entitas.

Hasil tindakan batch penautan entitas.

Kesalahan akibat tindakan penautan entitas pada satu dokumen.

Hasil tindakan penautan entitas pada satu dokumen.

Opsi untuk tindakan pengenalan entitas.

Hasil tindakan batch pengenalan entitas.

Kesalahan yang dihasilkan dari tindakan pengenalan entitas pada satu dokumen.

Hasil tindakan pengenalan entitas pada satu dokumen.

Parameter yang didukung untuk tugas Ringkasan Ekstraktif.

Hasil dari tindakan batch ringkasan ekstraktif.

Menentukan nilai untuk ExtractiveSummarizationOrderingCriteria.
KnownExtractiveSummarizationOrderingCriteria dapat digunakan secara bergantian dengan ExtractiveSummarizationOrderingCriteria, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Offset: Menunjukkan bahwa hasil harus diurutkan dalam urutan tampilan dalam teks.
Peringkat: Menunjukkan bahwa hasil harus diurutkan dalam urutan kepentingan (yaitu skor peringkat) sesuai dengan model.

Menentukan nilai untuk FhirVersion.
KnownFhirVersion dapat digunakan secara bergantian dengan FhirVersion, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

4.0.1

Parameter yang didukung untuk tugas Layanan Kesehatan.

Hasil dari tindakan batch layanan kesehatan.

Menentukan nilai untuk HealthcareEntityCategory.
<xref:KnownHealthcareEntityCategory> dapat digunakan secara bergantian dengan HealthcareEntityCategory, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

BODY_STRUCTURE
USIA
GENDER
EXAMINATION_NAME
TANGGAL
ARAH
FREKUENSI
MEASUREMENT_VALUE
MEASUREMENT_UNIT
RELATIONAL_OPERATOR
TIME
GENE_OR_PROTEIN
VARIAN
ADMINISTRATIVE_EVENT
CARE_ENVIRONMENT
HEALTHCARE_PROFESSION
DIAGNOSIS
SYMPTOM_OR_SIGN
CONDITION_QUALIFIER
MEDICATION_CLASS
MEDICATION_NAME
DOSIS
MEDICATION_FORM
MEDICATION_ROUTE
FAMILY_RELATION
TREATMENT_NAME

Jenis peran yang berbeda yang dapat dimainkan entitas layanan kesehatan dalam relasi.

Kesalahan akibat operasi layanan kesehatan pada satu dokumen.

Hasil operasi layanan kesehatan pada satu dokumen.

Opsi untuk tindakan pengenalan frasa kunci.

Hasil dari tindakan batch ekstraksi frasa kunci.

Kesalahan dihasilkan dari tindakan ekstraksi frasa kunci pada satu dokumen.

Hasil tindakan analisis sentimen pada satu dokumen.

Opsi untuk tindakan deteksi bahasa.

Kesalahan akibat tindakan deteksi bahasa pada satu dokumen.

Hasil tindakan deteksi bahasa pada satu dokumen.

Menentukan nilai untuk OperationStatus.

Hasil halaman operasi beginAnalyzeBatch.

Menentukan nilai untuk PiiEntityCategory.
KnownPiiEntityCategory dapat digunakan secara bergantian dengan PiiEntityCategory, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

ABARoutingNumber
ARNationalIdentityNumber
AUBankAccountNumber
AUDriversLicenseNumber
AUMedicalAccountNumber
AUPassportNumber
AUTaxFileNumber
AUBusinessNumber
AUCompanyNumber
ATIdentityCard
ATTaxIdentificationNumber
ATValueAddedTaxNumber
AzureDocumentDBAuthKey
AzureIAASDatabaseConnectionAndSQLString
AzureIoTConnectionString
AzurePublishSettingPassword
AzureRedisCacheString
AzureSAS
AzureServiceBusString
AzureStorageAccountKey
AzureStorageAccountGeneric
BENationalNumber
BENationalNumberV2
BEValueAddedTaxNumber
BRCPFNumber
BRLegalEntityNumber
BRNationalIDRG
BGUniformCivilNumber
CABankAccountNumber
CADriversLicenseNumber
CAHealthServiceNumber
CAPassportNumber
CAPersonalHealthIdentification
CASocialInsuranceNumber
CLIdentityCardNumber
CNResidentIdentityCardNumber
CreditCardNumber
HRIdentityCardNumber
HRNationalIDNumber
HRPersonalIdentificationNumber
HRPersonalIdentificationOIBNumberV2
CYIdentityCard
CYTaxIdentificationNumber
CZPersonalIdentityNumber
CZPersonalIdentityV2
DKPersonalIdentificationNumber
DKPersonalIdentificationV2
DrugEnforcementAgencyNumber
EEPersonalIdentificationCode
EUDebitCardNumber
EUDriversLicenseNumber
EUGPSCoordinates
EUNationalIdentificationNumber
EUPassportNumber
EUSocialSecurityNumber
EUTaxIdentificationNumber
FIEuropeanHealthNumber
FINationalID
FINationalIDV2
FIPassportNumber
FRDriversLicenseNumber
FRHealthInsuranceNumber
FRNationalID
FRPassportNumber
FRSocialSecurityNumber
FRTaxIdentificationNumber
FRValueAddedTaxNumber
DEDriversLicenseNumber
DEPassportNumber
DEIdentityCardNumber
DETaxIdentificationNumber
DEValueAddedNumber
GRNationalIDCard
GRNationalIDV2
GRTaxIdentificationNumber
HKIdentityCardNumber
HUValueAddedNumber
HUPersonalIdentificationNumber
HUTaxIdentificationNumber
INPermanentAccount
INUniqueIdentificationNumber
IDIdentityCardNumber
InternationalBankingAccountNumber
IEPersonalPublicServiceNumber
IEPersonalPublicServiceNumberV2
ILBankAccountNumber
ILNationalID
ITDriversLicenseNumber
ITFiscalCode
ITValueAddedTaxNumber
JPBankAccountNumber
JPDriversLicenseNumber
JPPassportNumber
JPResidentRegistrationNumber
JPSocialInsuranceNumber
JPMyNumberCorporate
JPMyNumberPersonal
JPResidenceCardNumber
LVPersonalCode
LTPersonalCode
LUNationalIdentificationNumberNatural
LUNationalIdentificationNumberNonNatural
MYIdentityCardNumber
MTIdentityCardNumber
MTTaxIDNumber
NLCitizensServiceNumber
NLCitizensServiceNumberV2
NLTaxIdentificationNumber
NLValueAddedTaxNumber
NZBankAccountNumber
NZDriversLicenseNumber
NZInlandRevenueNumber
NZMinistryOfHealthNumber
NZSocialWelfareNumber
NOIdentityNumber
PHUnifiedMultiPurposeIDNumber
PLIdentityCard
PLNationalID
PLNationalIDV2
PLPassportNumber
PLTaxIdentificationNumber
PLREGONNumber
PTCitizenCardNumber
PTCitizenCardNumberV2
PTTaxIdentificationNumber
ROPersonalNumericalCode
RUPassportNumberDomestic
RUPassportNumberInternational
SANationalID
SGNationalRegistrationIdentityCardNumber
SKPersonalNumber
SITaxIdentificationNumber
SIUniqueMasterCitizenNumber
ZAIdentificationNumber
KRResidentRegistrationNumber
ESDNI
ESSocialSecurityNumber
ESTaxIdentificationNumber
SQLServerConnectionString
SENationalID
SENationalIDV2
SEPassportNumber
SETaxIdentificationNumber
SWIFTCode
CHSocialSecurityNumber
TWNationalID
TWPassportNumber
TWResidentCertificate
THPopulationIdentificationCode
TRNationalIdentificationNumber
UKDriversLicenseNumber
UKElectoralRollNumber
UKNationalHealthNumber
UKNationalInsuranceNumber
UKUniqueTaxpayerNumber
USUKPassportNumber
USBankAccountNumber
USDriversLicenseNumber
USIndividualTaxpayerIdentification
USSocialSecurityNumber
UAPassportNumberDomestic
UAPassportNumberInternational
Organisasi
Email
URL
Usia
Nomor Telepon
IPAddress
Tanggal
Orang
Alamat
Semua
Standar

Menentukan nilai untuk PiiEntityDomain.
KnownPiiEntityDomain dapat digunakan secara bergantian dengan PiiEntityDomain, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

phi: Menunjukkan bahwa entitas di domain Informasi Kesehatan Pribadi harus diredaksi.
tidak ada: Menunjukkan bahwa tidak ada domain yang ditentukan.

Opsi untuk tindakan pengenalan entitas Pii.

Hasil tindakan batch pengenalan entitas pii.

Kesalahan akibat tindakan pengenalan entitas pii pada satu dokumen.

Hasil tindakan pengenalan entitas pada satu dokumen.

Menentukan nilai untuk RelationType.
<xref:KnownRelationType> dapat digunakan secara bergantian dengan RelationType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Singkatan
DirectionOfBodyStructure
DirectionOfCondition
DirectionOfExamination
DirectionOfTreatment
DosisOfMedication
FormOfMedication
FrequencyOfMedication
FrequencyOfTreatment
QualifierOfCondition
RelationOfExamination
RouteOfMedication
TimeOfCondition
TimeOfEvent
TimeOfExamination
TimeOfMedication
TimeOfTreatment
UnitOfCondition
UnitOfExamination
ValueOfCondition
ValueOfExamination

Menentukan nilai untuk SentenceSentimentLabel.

Opsi untuk tindakan analisis sentimen.

Hasil dari tindakan batch analisis sentimen.

Kesalahan dihasilkan dari tindakan analisis sentimen pada satu dokumen.

Hasil tindakan analisis sentimen pada satu dokumen.

Menentukan nilai untuk StringIndexType.
KnownStringIndexType dapat digunakan secara bergantian dengan StringIndexType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

TextElements_v8: Nilai offset dan panjang yang dikembalikan akan sesuai dengan TextElements (kluster Graphemes dan Grapheme) yang mengonfirmasi ke standar Unicode 8.0.0. Gunakan opsi ini jika aplikasi Anda ditulis dalam .Net Framework atau .Net Core dan Anda akan menggunakan StringInfo.
UnicodeCodePoint: Nilai offset dan panjang yang dikembalikan akan sesuai dengan titik kode Unicode. Gunakan opsi ini jika aplikasi Anda ditulis dalam bahasa yang mendukung Unicode, misalnya Python.
Utf16CodeUnit: Nilai offset dan panjang yang dikembalikan akan sesuai dengan unit kode UTF-16. Gunakan opsi ini jika aplikasi Anda ditulis dalam bahasa yang mendukung Unicode, misalnya Java, JavaScript.

Hasil kesalahan dari operasi ringkasan ekstrak pada satu dokumen.

Hasil operasi ringkasan ekstrak pada satu dokumen.

Menentukan nilai untuk TokenSentimentLabel.

Menentukan nilai untuk WarningCode.
<xref:KnownWarningCode> dapat digunakan secara bergantian dengan WarningCode, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

LongWordsInDocument
DocumentTruncated

Nilai KnownErrorCode yang diketahui yang diterima layanan.

Nilai yang diketahui dari ExtractiveSummarizationOrderingCriteria yang diterima layanan.

Nilai yang diketahui dari parameter <xref:HealthcareAction.fhirVersion>.

Nilai KnownInnerErrorCode yang diketahui yang diterima layanan.

Nilai yang diketahui dari PiiEntityCategory yang diterima layanan.

Nilai yang diketahui dari PiiEntityDomain yang diterima layanan.

Nilai yang diketahui dari StringIndexType yang diterima layanan.

Jenis tindakan yang didukung oleh metode analisis.

Jenis tindakan yang didukung oleh metode beginAnalyzeBatch.

Enum kemungkinan kode kesalahan dari TextAnalysisError.