你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/ai-text-analytics package

类

AzureKeyCredential	支持更新基础密钥值的基于静态密钥的凭据。
TextAnalyticsClient	用于与 Azure 文本分析交互的客户端类。

接口

AnalysisPollOperationState	表示分析轮询器作状态的接口。
AnalyzeActionsOperationMetadata	beginAnalyzeActions作的元数据。
AnalyzeActionsOperationState	开始分析轮询作的状态。
AnalyzeActionsResult	分析作的结果。
AnalyzeHealthcareEntitiesResultArray	AnalyzeHealthcareEntitiesResult 数组
AnalyzeHealthcareEntitiesSuccessResult	单个文档的成功医疗保健作的结果。
AnalyzeHealthcareOperationState	开始分析医疗保健轮询作的状态。
AnalyzeSentimentAction	分析情绪作的选项。
AnalyzeSentimentActionSuccessResult	成功分析情绪作的结果。
AnalyzeSentimentOptions	分析情绪作的选项。
AnalyzeSentimentResultArray	对应于一批输入文档的 AnalyzeSentimentResult 对象数组，并用批作信息进行批注。
AnalyzeSentimentSuccessResult	分析单个文档的情绪作的结果，其中包含每个句子以及完整文档的预测情绪。
AssessmentSentiment	AssessmentSentiment 包含有关目标评估的预测情绪、置信度分数和其他信息。 例如，在句子“食物良好”中，目标“food”的评估为“good”。
BeginAnalyzeActionsOptions	开始分析作的选项。
BeginAnalyzeHealthcareEntitiesOptions	开始分析医疗保健实体作的选项。
CategorizedEntity	文本分析中的实体，其中包含有关分类分类的信息。
DetectLanguageInput	语言检测作的输入。 此对象指定唯一的文档 ID，以及文档的全文，以及指示文档来源国家/地区的提示，以帮助文本分析预测模型检测文档的语言。
DetectLanguageOptions	检测语言作的选项。
DetectLanguageResultArray	对应于一批输入文档的 DetectLanguageResult 对象数组，并用批作信息进行批注。
DetectLanguageSuccessResult	对单个文档执行检测语言作的结果，其中包含对文档所写入语言的预测。
DetectedLanguage	有关文本分析服务标识的文档语言的信息。
Entity	标识为属于类型分类的实体的单词或短语。 文本分析服务识别的类别集在 https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types 中介绍。
EntityAssertion
EntityDataSource	一种类型，表示医疗保健实体在特定实体目录中的引用。
ExtractKeyPhrasesAction	关键短语识别作的选项。
ExtractKeyPhrasesActionSuccessResult	成功提取关键短语作的结果。
ExtractKeyPhrasesOptions	提取关键短语作的选项。
ExtractKeyPhrasesResultArray	对应于一批输入文档的 ExtractKeyPhrasesResult 对象数组，并用批作信息进行批注。
ExtractKeyPhrasesSuccessResult	对单个文档执行提取关键短语作的结果，其中包含该文档中标识的关键短语的集合。
HealthcareEntity	表示为定向图中的节点的医疗保健实体，其中边缘是源节点和目标节点之间的特定关系类型。
HealthcareEntityRelation	两个或多个医疗保健实体之间的关系。
HealthcareEntityRelationRole	在关系中扮演特定角色的医疗保健实体。
LinkedEntity	标识为数据库中已知实体的单词或短语，包括其正式（消除歧义）名称和指向源数据库中的实体信息的链接。
Match	有关文档中特定子字符串的详细信息，该子字符串引用文本分析模型标识的链接实体。
OperationMetadata	分析轮询器作的元数据信息。
Opinion	挖掘的意见对象表示我们从句子中提取的一种观点。 它由这些评估所涉及的目标和实际评估本身组成。
PagedAnalyzeActionsResult	分析作的结果，表示为分页迭代器，循环访问所请求作的结果。
PagedAnalyzeHealthcareEntitiesResult	表示为分页迭代器的医疗保健作的结果，可以逐文档循环访问结果，或者 byPage（）可以循环访问文档的页面。
PiiEntity	来自 PII 识别的实体，其中包含有关所遇到的 PII 类型的信息。
RecognizeCategorizedEntitiesAction	实体识别作的选项。
RecognizeCategorizedEntitiesActionSuccessResult	成功识别的已分类实体作的结果。
RecognizeCategorizedEntitiesOptions	识别实体作的选项。
RecognizeCategorizedEntitiesResultArray	对应于一批输入文档的 RecognizeCategorizedEntitiesResult 对象数组，并用批作信息进行批注。
RecognizeCategorizedEntitiesSuccessResult	对单个文档执行识别实体作的结果，其中包含该文档中标识的 Entity 对象的集合。
RecognizeLinkedEntitiesAction	实体链接作的选项。
RecognizeLinkedEntitiesActionSuccessResult	成功识别链接实体作的结果。
RecognizeLinkedEntitiesOptions	识别链接实体作的选项。
RecognizeLinkedEntitiesResultArray	对应于一批输入文档的 RecognizeLinkedEntitiesResult 对象数组，并用批作信息进行批注。
RecognizeLinkedEntitiesSuccessResult	对单个文档执行识别链接实体作的结果，其中包含该文档中标识的 LinkedEntity 对象的集合。
RecognizePiiEntitiesAction	Pii 实体识别作的选项。
RecognizePiiEntitiesActionSuccessResult	成功识别 pii 实体作的结果。
RecognizePiiEntitiesOptions	识别 PII 实体作的选项。
RecognizePiiEntitiesResultArray	与一批输入文档相对应的 RecognizePiiEntitiesResult 对象的集合，并用批作信息进行批注。
RecognizePiiEntitiesSuccessResult	对单个文档执行识别实体作的结果，其中包含该文档中标识的 Entity 对象的集合。
SentenceAssessment
SentenceSentiment	给定文本范围的预测情绪。 有关文本情绪的详细信息，请参阅 https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/how-tos/text-analytics-how-to-sentiment-analysis。
SentimentConfidenceScores	表示所有情绪类中介于 0 和 1 之间的置信度分数：正、中性、负数。
TargetConfidenceScoreLabel	表示所有情绪类的置信度分数：正、中性、负数。
TargetSentiment	TargetSentiment 包含有关产品目标的预测情绪、置信度分数和其他信息。 产品/服务的目标是该产品/服务的关键组成部分。 例如，在“Foo 酒店的食物很好”中，“food”是“Hotel Foo”的目标。
TextAnalyticsAction	文本分析作的类型。
TextAnalyticsActionErrorResult	分析批处理作的错误。
TextAnalyticsActionSuccessState	成功作的状态。
TextAnalyticsActions	分析 API 要对输入文档执行的作集合的说明。 但是，目前，服务最多可以接受每个作类型一个作。
TextAnalyticsClientOptions	用于配置 TextAnalytics API 请求的客户端选项。
TextAnalyticsError	描述文本分析服务中的错误的类型。
TextAnalyticsErrorResult	与单个文档对应的文本分析作的错误结果的基类型。
TextAnalyticsOperationOptions	所有文本分析作通用的选项。
TextAnalyticsSuccessResult	与单个输入文档对应的文本分析作结果的基类型。
TextAnalyticsWarning	表示处理文档时遇到的警告。
TextDocumentBatchStatistics	如果在请求中指定 includeStatistics=true，则此字段将包含有关请求有效负载的信息。
TextDocumentInput	一个对象，表示文本分析服务要分析的单个文本文档。 该文档包含唯一的文档 ID、文档的全文以及文档文本的语言。
TextDocumentStatistics	如果在请求中指定 includeStatistics=true，则此字段将包含有关文档有效负载的信息。

类型别名

AnalyzeActionsPollerLike	Begin Analyze Actions Long-Running-Operation（LRO）的结果类型。
AnalyzeHealthcareEntitiesErrorResult	单个文档中医疗保健作导致的错误。
AnalyzeHealthcareEntitiesPollerLike	健康长Running-Operation 的结果类型（LRO）
AnalyzeHealthcareEntitiesResult	单个文档中医疗保健作的结果。
AnalyzeSentimentActionErrorResult	分析情绪作的错误。
AnalyzeSentimentActionResult	分析情绪作的结果。
AnalyzeSentimentErrorResult	分析单个文档的情绪作导致的错误。
AnalyzeSentimentResult	分析单个文档的情绪作的结果。
DetectLanguageErrorResult	单个文档上的检测朗格作导致的错误。
DetectLanguageResult	单个文档上的检测语言作的结果。
DocumentSentimentLabel	定义 DocumentSentimentLabel 的值。
EntityAssociation	定义关联的值。
EntityCertainty	定义 Certainty 的值。
EntityConditionality	定义条件性的值。
ErrorCode	文本分析服务返回的错误代码。 可能的值包括： 有关错误的详细信息，请参阅关联的错误的 message 属性。
ErrorCodeValue	定义 ErrorCodeValue 的值。 <xref:KnownErrorCodeValue> 可与 ErrorCodeValue 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 InvalidRequest InvalidArgument InternalServerError ServiceUnavailable NotFound
ExtractKeyPhrasesActionErrorResult	提取关键短语作的错误。
ExtractKeyPhrasesActionResult	提取关键短语作的结果。
ExtractKeyPhrasesErrorResult	提取单个文档中关键短语作导致的错误。
ExtractKeyPhrasesResult	对单个文档执行提取关键短语作的结果。
HealthcareEntityCategory	定义 HealthcareEntityCategory 的值。 KnownHealthcareEntityCategory 可与 HealthcareEntityCategory 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 BODY_STRUCTURE AGE 性别 EXAMINATION_NAME DATE 方向 FREQUENCY MEASUREMENT_VALUE MEASUREMENT_UNIT RELATIONAL_OPERATOR 时间 GENE_OR_PROTEIN VARIANT ADMINISTRATIVE_EVENT CARE_ENVIRONMENT HEALTHCARE_PROFESSION 诊断 SYMPTOM_OR_SIGN CONDITION_QUALIFIER MEDICATION_CLASS MEDICATION_NAME 剂量 MEDICATION_FORM MEDICATION_ROUTE FAMILY_RELATION TREATMENT_NAME
HealthcareEntityRelationRoleType	医疗保健实体可以在关系中扮演的不同角色的类型。
HealthcareEntityRelationType	定义 RelationType 的值。 <xref:KnownRelationType> 可与 RelationType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 缩写 DirectionOfBodyStructure DirectionOfCondition DirectionOfExamination DirectionOfTreatment 剂量OfMedication FormOfMedication FrequencyOfMedication FrequencyOfTreatment QualifierOfCondition RelationOfExamination RouteOfMedication TimeOfCondition TimeOfEvent TimeOfExamination TimeOfMedication TimeOfTreatment UnitOfCondition UnitOfExamination ValueOfCondition ValueOfExamination
InnerErrorCodeValue	定义 InnerErrorCodeValue 的值。 KnownInnerErrorCodeValue 可与 InnerErrorCodeValue 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 InvalidParameterValue InvalidRequestBodyFormat EmptyRequest MissingInputRecords InvalidDocument ModelVersionIncorrect InvalidDocumentBatch UnsupportedLanguageCode InvalidCountryHint
PagedAsyncIterableAnalyzeActionsResult	分析作的结果，表示为分页迭代器，循环访问所请求作的结果。
PagedAsyncIterableAnalyzeHealthcareEntitiesResult	表示为分页迭代器的医疗保健作的结果，可以逐文档循环访问结果，或者 byPage（）可以循环访问文档的页面。
PiiEntityCategory	定义 PiiCategory 的值。 <xref:KnownPiiCategory> 可与 PiiCategory 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 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 组织 电子邮件 URL 年龄 PhoneNumber IPAddress 日期 人员 地址 所有 默认
RecognizeCategorizedEntitiesActionErrorResult	识别分类实体作的错误。
RecognizeCategorizedEntitiesActionResult	识别的分类实体作的结果。
RecognizeCategorizedEntitiesErrorResult	识别单个文档上的实体作导致的错误。
RecognizeCategorizedEntitiesResult	对单个文档执行识别实体作的结果。
RecognizeLinkedEntitiesActionErrorResult	识别链接实体作的错误。
RecognizeLinkedEntitiesActionResult	识别链接实体作的结果。
RecognizeLinkedEntitiesErrorResult	识别链接实体作对单个文档的错误。
RecognizeLinkedEntitiesResult	对单个文档执行识别链接实体作的结果。
RecognizePiiEntitiesActionErrorResult	识别 pii 实体作的错误。
RecognizePiiEntitiesActionResult	识别 pii 实体作的结果。
RecognizePiiEntitiesErrorResult	识别单个文档上的实体作导致的错误。
RecognizePiiEntitiesResult	对单个文档执行识别实体作的结果。
SentenceSentimentLabel	定义 SentenceSentimentLabel 的值。
StringIndexType	用于计算偏移量和长度属性的度量单位。
TextAnalyticsOperationStatus	定义 State 的值。
TokenSentimentValue	定义 TokenSentimentValue 的值。
WarningCode	定义 WarningCode 的值。 KnownWarningCode 可与 WarningCode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 LongWordsInDocument DocumentTruncated

枚举

KnownHealthcareEntityCategory	HealthcareEntityCategory 服务的已知值。
KnownInnerErrorCodeValue	InnerErrorCodeValue 的已知值 服务接受的值。
KnownWarningCode	服务的 WarningCode 的已知值。
PiiEntityDomain	用户可以从中选择的 PII 域的类型。