@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	語言偵測作業的輸入。 此物件會指定唯一的文件標識碼，以及檔的全文檢索，以及指出檔原籍國的提示，以協助文字分析預測模型偵測文件的語言。
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	物件，代表文字分析服務要分析的個別文字檔。 檔包含唯一的文件識別碼、檔的全文，以及檔文字的語言。
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	Service 接受的 InnerErrorCodeValue 已知值。
KnownWarningCode	服務的已知值 WarningCode。
PiiEntityDomain	用戶可以選擇的 PII 網域類型。