@azure/ai-text-analytics package

A static-key-based credential that supports updating the underlying key value.

Client class for interacting with Azure Text Analytics.

An interface representing the state of an analysis poller operation.

The metadata for beginAnalyzeActions operations.

The state of the begin analyze polling operation.

The results of an analyze Actions operation.

Array of AnalyzeHealthcareEntitiesResult

The results of a successful healthcare operation for a single document.

The state of the begin analyze healthcare polling operation.

Options for an analyze sentiment action.

The results of a succeeded analyze sentiment action.

Options for the analyze sentiment operation.

Array of AnalyzeSentimentResult objects corresponding to a batch of input documents, and annotated with information about the batch operation.

The result of the analyze sentiment operation on a single document, containing the predicted sentiment for each sentence as well as for the full document.

AssessmentSentiment contains the predicted sentiment, confidence scores and other information about an assessment of a target. For example, in the sentence "The food is good", the assessment of the target 'food' is 'good'.

Options for the begin analyze actions operation.

Options for the begin analyze healthcare entities operation.

An entity from text analysis with information about its categorical classification.

An input to the language detection operation. This object specifies a unique document id, as well as the full text of a document and a hint indicating the document's country of origin to assist the text analytics predictive model in detecting the document's language.

Options for the detect languages operation.

Array of DetectLanguageResult objects corresponding to a batch of input documents, and annotated with information about the batch operation.

The result of the detect language operation on a single document, containing a prediction of what language the document is written in.

Information about the language of a document as identified by the Text Analytics service.

A word or phrase identified as an entity that is categorized within a taxonomy of types. The set of categories recognized by the Text Analytics service is described at https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types .

A type representing a reference for the healthcare entity into a specific entity catalog.

Options for a key phrases recognition action.

The results of a succeeded extract key phrases action.

Options for the extract key phrases operation.

Array of ExtractKeyPhrasesResult objects corresponding to a batch of input documents, and annotated with information about the batch operation.

The result of the extract key phrases operation on a single document, containing a collection of the key phrases identified in that document.

A healthcare entity represented as a node in a directed graph where the edges are a particular type of relationship between the source and target nodes.

A relationship between two or more healthcare entities.

A healthcare entity that plays a specific role in a relation.

A word or phrase identified as a well-known entity within a database, including its formal (disambiguated) name and a link to the entity information within the source database.

Details about the specific substring in a document that refers to a linked entity identified by the Text Analytics model.

Metadata information for an analysis poller operation.

A mined opinion object represents an opinion we've extracted from a sentence. It consists of both a target that these assessments are about, and the actual assessments themselves.

The results of an analyze actions operation represented as a paged iterator that iterates over the results of the requested actions.

The results of a healthcare operation represented as a paged iterator that can either iterate over the results on a document-by-document basis or, by byPage(), can iterate over pages of documents.

An entity from PII recognition with information about the kind of PII encountered.

Options for an entities recognition action.

The results of a succeeded recognize categorized entities action.

Options for the recognize entities operation.

Array of RecognizeCategorizedEntitiesResult objects corresponding to a batch of input documents, and annotated with information about the batch operation.

The result of the recognize entities operation on a single document, containing the collection of Entity objects identified in that document.

Options for an entities linking action.

The results of a succeeded recognize linked entities action.

Options for the recognize linked entities operation.

Array of RecognizeLinkedEntitiesResult objects corresponding to a batch of input documents, and annotated with information about the batch operation.

The result of the recognize linked entities operation on a single document, containing a collection of the LinkedEntity objects identified in that document.

Options for a Pii entities recognition action.

The results of a succeeded recognize pii entities action.

Options for the recognize PII entities operation.

Collection of RecognizePiiEntitiesResult objects corresponding to a batch of input documents, and annotated with information about the batch operation.

The result of the recognize entities operation on a single document, containing the collection of Entity objects identified in that document.

The predicted sentiment for a given span of text. For more information regarding text sentiment, see https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/how-tos/text-analytics-how-to-sentiment-analysis.

Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.

Represents the confidence scores across all sentiment classes: positive, neutral, negative.

TargetSentiment contains the predicted sentiment, confidence scores and other information about an target of a product. A target of a product/service is a key component of that product/service. For example in "The food at Hotel Foo is good", "food" is a target of "Hotel Foo".

The type of a text analytics action.

The error of an analyze batch action.

The state of a succeeded action.

Description of collection of actions for the analyze API to perform on input documents. However, currently, the service can accept up to one action only per action type.

Client options used to configure TextAnalytics API requests.

Type describing an error from the Text Analytics service.

Base type for error results of text analytics operations corresponding to a single document.

Options common to all text analytics operations.

Base type for results of text analytics operations corresponding to a single input document.

Represents a warning encountered while processing a document.

if includeStatistics=true was specified in the request this field will contain information about the request payload.

An object representing an individual text document to be analyzed by the Text Analytics service. The document contains a unique document ID, the full text of the document, and the language of the document's text.

if includeStatistics=true was specified in the request this field will contain information about the document payload.

Result type of the Begin Analyze Actions Long-Running-Operation (LRO).

An error result from the healthcare operation on a single document.

Result type of the Health Long-Running-Operation (LRO)

The result of the healthcare operation on a single document.

The error of an analyze sentiment action.

The result of an analyze sentiment action.

An error result from the analyze sentiment operation on a single document.

The result of the analyze sentiment operation on a single document.

An error result from the detect languge operation on a single document.

The result of the detect language operation on a single document.

Defines values for DocumentSentimentLabel.

Defines values for Association.

Defines values for Certainty.

Defines values for Conditionality.

An Error Code returned from the Text Analytics service. Possible values include:

For more information about the error, see the message property of the associated error.

Defines values for ErrorCodeValue.
<xref:KnownErrorCodeValue> can be used interchangeably with ErrorCodeValue, this enum contains the known values that the service supports.

Known values supported by the service

InvalidRequest
InvalidArgument
InternalServerError
ServiceUnavailable
NotFound

The error of a extract key phrases action.

The result of a extract key phrases action.

An error result from the extract key phrases operation on a single document.

The result of the extract key phrases operation on a single document.

Defines values for HealthcareEntityCategory.
KnownHealthcareEntityCategory can be used interchangeably with HealthcareEntityCategory, this enum contains the known values that the service supports.

Known values supported by the service

BODY_STRUCTURE
AGE
GENDER
EXAMINATION_NAME
DATE
DIRECTION
FREQUENCY
MEASUREMENT_VALUE
MEASUREMENT_UNIT
RELATIONAL_OPERATOR
TIME
GENE_OR_PROTEIN
VARIANT
ADMINISTRATIVE_EVENT
CARE_ENVIRONMENT
HEALTHCARE_PROFESSION
DIAGNOSIS
SYMPTOM_OR_SIGN
CONDITION_QUALIFIER
MEDICATION_CLASS
MEDICATION_NAME
DOSAGE
MEDICATION_FORM
MEDICATION_ROUTE
FAMILY_RELATION
TREATMENT_NAME

The type of different roles a healthcare entity can play in a relation.

Defines values for RelationType.
<xref:KnownRelationType> can be used interchangeably with RelationType, this enum contains the known values that the service supports.

Known values supported by the service

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

Defines values for InnerErrorCodeValue.
KnownInnerErrorCodeValue can be used interchangeably with InnerErrorCodeValue, this enum contains the known values that the service supports.

Known values supported by the service

InvalidParameterValue
InvalidRequestBodyFormat
EmptyRequest
MissingInputRecords
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

The results of an analyze Actions operation represented as a paged iterator that iterates over the results of the requested actions.

The results of a healthcare operation represented as a paged iterator that can either iterate over the results on a document-by-document basis or, by byPage(), can iterate over pages of documents.

Defines values for PiiCategory.
<xref:KnownPiiCategory> can be used interchangeably with PiiCategory, this enum contains the known values that the service supports.

Known values supported by the service

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
Organization
Email
URL
Age
PhoneNumber
IPAddress
Date
Person
Address
All
Default

The error of a recognize categorized entities action.

The result of a recognize categorized entities action.

An error result from the recognize entities operation on a single document.

The result of the recognize entities operation on a single document.

The error of a recognize linked entities action.

The result of a recognize linked entities action.

An error result from the recognize linked entities operation on a single document.

The result of the recognize linked entities operation on a single document.

The error of a recognize pii entities action.

The result of a recognize pii entities action.

An error result from the recognize entities operation on a single document.

The result of the recognize entities operation on a single document.

Defines values for SentenceSentimentLabel.

Measurement units that can used to calculate the offset and length properties.

Defines values for State.

Defines values for TokenSentimentValue.

Defines values for WarningCode.
KnownWarningCode can be used interchangeably with WarningCode, this enum contains the known values that the service supports.

Known values supported by the service

LongWordsInDocument
DocumentTruncated

Known values of HealthcareEntityCategory that the service accepts.

Known values of InnerErrorCodeValue that the service accepts.

Known values of WarningCode that the service accepts.

The types of PII domains the user can choose from.