@azure/ai-text-analytics package

En statisk nyckelbaserad autentiseringsuppgift som stöder uppdatering av det underliggande nyckelvärdet.

En klient för att interagera med textanalysfunktionerna i Azure Cognitive Language Service.

Klienten behöver slutpunkten för en språkresurs och en autentiseringsmetod, till exempel en API-nyckel eller AAD. API-nyckeln och slutpunkten finns på sidan Språkresurs i Azure-portalen. De kommer att finnas på resursens nyckel- och slutpunktssida under Resurshantering.

Exempel på autentisering:

API-nyckel

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

Mer information om autentisering med Azure Active Directory finns i @azure/identity-paketet.

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

Konfiguration som är gemensam för alla åtgärder.

Åtgärdsmetadata.

Alternativ som är gemensamma för alla batchåtgärder.

Metadata för långvariga åtgärder som startades av beginAnalyzeBatch.

Tillståndet för startanalysen analyserar avsökningsåtgärden.

Ett objekt som innehåller den förutsagda attityden, konfidenspoängen och annan information om en bedömning av ett mål. Till exempel, i meningen "Maten är bra" är bedömningen av målet "mat" "bra".

Felet för en analys av batchåtgärden.

Tillståndet för en batchåtgärd

Tillståndet för en slutförd batchåtgärd.

Alternativ för åtgärden Börja analysera åtgärder.

Ett klassificeringsresultat från en anpassad åtgärd för att klassificera dokument med en enskild kategori

Metadata för anpassad åtgärd.

Alternativ för en batchåtgärd för anpassad entitetsigenkänning.

Resultatet av åtgärden identifiera anpassade entiteter i ett enda dokument som innehåller en samling av de entiteter som identifieras i dokumentet.

Alternativ för en anpassad batchåtgärd för klassificering med flera etiketter.

Resultatet av åtgärden custom classify document multi categories (Klassificera dokument med flera kategorier) i ett flerdokument som innehåller resultatet av klassificeringen.

Alternativ för en anpassad batchåtgärd för klassificering med en enda etikett.

Resultatet av åtgärden custom classify document single category i ett enskilt dokument som innehåller resultatet av klassificeringen.

Information om språket i ett dokument som identifieras av språktjänsten.

Representerar en varning som påträffades när ett dokument bearbetas.

Ett ord eller en fras som identifieras som en entitet som kategoriseras inom en taxonomi av typer. Den uppsättning kategorier som identifieras av språktjänsten beskrivs i https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories .

En typ som representerar en referens för sjukvårdsentiteten till en specifik entitetskatalog.

Alternativ för en entitet som länkar batchåtgärder.

Resultatet av en entitetslänkningsåtgärd i ett enda dokument som innehåller en samling LinkedEntity objekt som identifierats i dokumentet.

Alternativ för en batchåtgärd för entitetsigenkänning.

Resultatet av en entitetsigenkänningsåtgärd i ett enda dokument, som innehåller en samling entitetsobjekt objekt som identifieras i dokumentet.

Alternativ för en batchåtgärd för extraherande sammanfattning.

Ett objekt som beskriver metadata om sjukvårdsentiteten, till exempel om det är hypotetiskt eller villkorsstyrt.

Alternativ för en sjukvårdsbatchåtgärd.

En sjukvårdsentitet som representeras som en nod i ett riktat diagram där kanterna är en viss typ av relation mellan käll- och målnoderna.

En relation mellan två eller flera sjukvårdsentiteter.

En sjukvårdsentitet som spelar en specifik roll i en relation.

Resultatet av en lyckad sjukvårdsåtgärd för ett enda dokument.

Alternativ för en batchåtgärd för extrahering av nyckelfraser.

Resultatet av en extraheringsåtgärd för nyckelfraser i ett enda dokument som innehåller en samling nyckelfraser som identifieras i dokumentet.

Indata till språkidentifieringsåtgärden. Det här objektet anger ett unikt dokument-ID, samt den fullständiga texten i ett dokument och ett tips som anger dokumentets ursprungsland för att hjälpa språk förutsägelsemodellen att identifiera dokumentets språk.

Resultatet av en språkidentifieringsåtgärd i ett enda dokument som innehåller en förutsägelse om vilket språk dokumentet är skrivet i.

Ett ord eller en fras som identifieras som en välkänd entitet i en databas, inklusive dess formella (tvetydiga) namn och en länk till entitetsinformationen i källdatabasen.

Information om den specifika delsträngen i ett dokument som refererar till en länkad entitet som identifieras av språkmodellen.

Ett minerat åsiktsobjekt representerar en åsikt som vi har extraherat från en mening. Den består av både ett mål som dessa utvärderingar handlar om och själva utvärderingarna.

Alternativ för en pii-entitetsigenkänningsbatchåtgärd.

Resultatet av en pii-entitetsigenkänningsåtgärd i ett enda dokument som innehåller samlingen av Entitet objekt som identifieras i dokumentet.

Alternativ för åtgärden Börja analysera åtgärder.

Den förutsagda attityden för ett givet textintervall. Mer information om textsentiment finns i https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Alternativ för en batchåtgärd för attitydanalys.

Resultatet av en attitydanalysåtgärd i ett enda dokument som innehåller den förutsagda attityden för varje mening samt för det fullständiga dokumentet.

Representerar konfidenspoängen mellan 0 och 1 i alla sentimentklasser: positiv, neutral, negativ.

Resultatet av sammanfattningsextraheringsåtgärden för ett enskilt dokument som innehåller en samling sammanfattningar som identifieras i dokumentet.

En mening som ingår i den extraherade sammanfattningen.

Representerar konfidenspoängen i alla sentimentklasser: positiv, neutral, negativ.

TargetSentiment innehåller den förutsagda attityden, konfidenspoängen och annan information om ett mål för en produkt. Ett mål för en produkt/tjänst är en viktig komponent i den produkten/tjänsten. Till exempel i "Maten på Hotel Foo är bra" är "mat" ett mål för "Hotel Foo".

Konfigurationsalternativ för TextAnalysisClient.

Skriv som beskriver ett API-fel.

Bastyp för felresultat för en åtgärd som motsvarar ett enskilt dokument.

Alternativ som är gemensamma för alla åtgärder.

Bastyp för resultatet av en åtgärd som motsvarar ett enda indatadokument.

om includeStatistics=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

Ett objekt som representerar ett enskilt textdokument som ska analyseras av språktjänsten. Dokumentet innehåller ett unikt dokument-ID, dokumentets fullständiga text och språket i dokumentets text.

om includeStatistics=true angavs i begäran innehåller det här fältet information om dokumentnyttolasten.

Parameterobjekt för en textanalysaktivitet med hjälp av anpassade modeller.

Konfiguration som är gemensam för alla åtgärder som använder fördefinierade modeller.

Typ av åtgärder som stöds av metoden analysera.

Typ av parametrar för varje åtgärd i $AnalyzeActionNames.

Batch med åtgärder.

Typ av åtgärder som stöds av metoden beginAnalyzeBatch.

En poller som avsöker långvariga åtgärder som startats av beginAnalyzeBatch.

Resultat av en batch med åtgärder.

Typ av resultat för varje åtgärd i $AnalyzeActionNames.

Resultatet av en batchåtgärd.

Parametrar som stöds för en anpassad entitetsaktivitet.

Resultatet av en batchåtgärd för anpassad entitetsigenkänning.

Ett fel uppstår när åtgärden identifiera anpassade entiteter identifieras i ett enda dokument.

Resultatet av åtgärden anpassade identifiera entiteter i ett enda dokument.

Alternativ för en anpassad åtgärd för klassificering med flera etiketter

Resultatet av en anpassad batchåtgärd för klassificering med flera etiketter.

Ett fel beror på åtgärden för att klassificera dokument med flera kategorier i ett flerdokument.

Resultatet av åtgärden för att klassificera dokument med flera kategorier i ett flerdokument.

Alternativ för en anpassad åtgärd för klassificering med en enda etikett

Resultatet av en anpassad batchåtgärd för klassificering med en enda etikett.

Ett fel beror på den anpassade åtgärden klassificera dokument med en enskild kategori i ett enda dokument.

Resultatet av den anpassade åtgärden klassificera dokument med en enskild kategori i ett enda dokument.

Definierar värden för DocumentSentimentLabel.

Definierar värden för EntityAssociation.

Definierar värden för EntityCertainty.

Definierar värden för EntityConditionality.

Alternativ för en entitetslänkningsåtgärd.

Resultatet av en entitetslänkning av batchåtgärd.

Ett fel beror på en entitetslänkningsåtgärd i ett enda dokument.

Resultatet av en entitetslänkningsåtgärd i ett enda dokument.

Alternativ för en entitetsigenkänningsåtgärd.

Resultatet av en batchåtgärd för entitetsigenkänning.

Ett fel beror på en entitetsigenkänningsåtgärd i ett enda dokument.

Resultatet av en entitetsigenkänningsåtgärd i ett enda dokument.

Parametrar som stöds för en extraheringssammanfattningsaktivitet.

Resultatet av en batchåtgärd för extraherande sammanfattning.

Definierar värden för ExtractiveSummarizationOrderingCriteria.
KnownExtractiveSummarizationOrderingCriteria kan användas utbytbart med ExtractiveSummarizationOrderingCriteria innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Offset: Anger att resultatet ska sorteras efter utseende i texten.
Rank: Anger att resultaten ska sorteras i prioritetsordning (dvs. rangpoäng) enligt modellen.

Definierar värden för FhirVersion.
KnownFhirVersion kan användas omväxlande med FhirVersion innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

4.0.1

Parametrar som stöds för en sjukvårdsaktivitet.

Resultatet av en sjukvårdsbatchåtgärd.

Definierar värden för HealthcareEntityCategory.
<xref:KnownHealthcareEntityCategory> kan användas omväxlande med HealthcareEntityCategory innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

BODY_STRUCTURE
AGE
kön
EXAMINATION_NAME
DATUM
RIKTNING
FREQUENCY
MEASUREMENT_VALUE
MEASUREMENT_UNIT
RELATIONAL_OPERATOR
TIME
GENE_OR_PROTEIN
VARIANT
ADMINISTRATIVE_EVENT
CARE_ENVIRONMENT
HEALTHCARE_PROFESSION
DIAGNOS
SYMPTOM_OR_SIGN
CONDITION_QUALIFIER
MEDICATION_CLASS
MEDICATION_NAME
DOSERING
MEDICATION_FORM
MEDICATION_ROUTE
FAMILY_RELATION
TREATMENT_NAME

Typen av olika roller som en sjukvårdsentitet kan spela i en relation.

Ett fel beror på sjukvårdsåtgärden i ett enda dokument.

Resultatet av hälso- och sjukvårdsåtgärden i ett enda dokument.

Alternativ för en nyckelfrasigenkänningsåtgärd.

Resultatet av en batchåtgärd för extrahering av nyckelfraser.

Ett fel beror på en extraheringsåtgärd för nyckelfraser i ett enda dokument.

Resultatet av en attitydanalysåtgärd i ett enda dokument.

Alternativ för en språkidentifieringsåtgärd.

Ett fel beror på en språkidentifieringsåtgärd i ett enda dokument.

Resultatet av en språkidentifieringsåtgärd i ett enda dokument.

Definierar värden för OperationStatus.

Sidsidiga resultat av beginAnalyzeBatch åtgärd.

Definierar värden för PiiEntityCategory.
KnownPiiEntityCategory kan användas omväxlande med PiiEntityCategory innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

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
Organisation
e-post
URL
Ålder
Telefonnummer
IPAddress
datum
Person
Adress
Alla
Standardinställning

Definierar värden för PiiEntityDomain.
KnownPiiEntityDomain kan användas omväxlande med PiiEntityDomain innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

phi: Anger att entiteter i domänen personlig hälsoinformation ska redigeras.
ingen: Anger att ingen domän har angetts.

Alternativ för en pii-entitetsigenkänningsåtgärd.

Resultatet av en pii-entitetsigenkänningsbatchåtgärd.

Ett fel beror på en pii-entitetsigenkänningsåtgärd i ett enda dokument.

Resultatet av en entitetsigenkänningsåtgärd i ett enda dokument.

Definierar värden för RelationType.
<xref:KnownRelationType> kan användas utbytbart med RelationType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Förkortning
DirectionOfBodyStructure
DirectionOfCondition
DirectionOfExamination
DirectionOfTreatment
DosageOfMedication
FormOfMedication
FrequencyOfMedication
FrequencyOfTreatment
QualifierOfCondition
RelationOfExamination
RouteOfMedication
TimeOfCondition
TimeOfEvent
TimeOfExamination
TimeOfMedication
TimeOfTreatment
UnitOfCondition
UnitOfExamination
ValueOfCondition
ValueOfExamination

Definierar värden för SentenceSentimentLabel.

Alternativ för en attitydanalysåtgärd.

Resultatet av en batchåtgärd för attitydanalys.

Ett fel beror på en attitydanalysåtgärd i ett enda dokument.

Resultatet av en attitydanalysåtgärd i ett enda dokument.

Definierar värden för StringIndexType.
KnownStringIndexType kan användas utbytbart med StringIndexType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

TextElements_v8: Returnerade förskjutnings- och längdvärden motsvarar TextElements (Graphemes- och Grapheme-kluster) som bekräftar unicode 8.0.0-standarden. Använd det här alternativet om ditt program är skrivet i .Net Framework eller .Net Core och du kommer att använda StringInfo.
UnicodeCodePoint: Returnerade förskjutnings- och längdvärden motsvarar Unicode-kodpunkter. Använd det här alternativet om programmet är skrivet på ett språk som stöder Unicode, till exempel Python.
Utf16CodeUnit: Returnerade förskjutnings- och längdvärden motsvarar UTF-16-kodenheter. Använd det här alternativet om ditt program är skrivet på ett språk som stöder Unicode, till exempel Java, JavaScript.

Ett fel uppstår när sammanfattningsåtgärden extraheras i ett enda dokument.

Resultatet av extraheringssammanfattningsåtgärden i ett enda dokument.

Definierar värden för TokenSentimentLabel.

Definierar värden för WarningCode.
<xref:KnownWarningCode> kan användas omväxlande med WarningCode innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

LongWordsInDocument
DocumentTruncated

Kända värden för KnownErrorCode som tjänsten accepterar.

Kända värden för ExtractiveSummarizationOrderingCriteria som tjänsten accepterar.

Kända värden för parametern <xref:HealthcareAction.fhirVersion>.

Kända värden för KnownInnerErrorCode som tjänsten accepterar.

Kända värden för PiiEntityCategory som tjänsten accepterar.

Kända värden för PiiEntityDomain som tjänsten accepterar.

Kända värden för StringIndexType som tjänsten accepterar.

Typ av åtgärder som stöds av metoden analysera.

Typ av åtgärder som stöds av metoden beginAnalyzeBatch.

En mängd möjliga felkoder för en TextAnalysisError.