@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	Mined 意見物件代表我們已從句子中擷取的意見。它包含這些評量有關的目標，以及實際評量本身。
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 包含預測情感、信賴分數，以及產品目標的其他資訊。產品/服務的目標是該產品/服務的重要元件。例如，在「Hotel 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	健全狀況長時間執行作業 (LRO) 的結果類型
AnalyzeHealthcareEntitiesResult	單一檔上的醫療保健作業結果。
AnalyzeSentimentActionErrorResult	分析情感動作的錯誤。
AnalyzeSentimentActionResult	分析情感動作的結果。
AnalyzeSentimentErrorResult	單一檔上分析情感作業所產生的錯誤。
AnalyzeSentimentResult	在單一檔上分析情感作業的結果。
DetectLanguageErrorResult	單一檔上偵測語言作業所產生的錯誤。
DetectLanguageResult	在單一檔上偵測語言作業的結果。
DocumentSentimentLabel	定義 DocumentSentimentLabel 的值。
EntityAssociation	定義 Association 的值。
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 年齡性別 EXAMINATION_NAME DATE 方向頻率 MEASUREMENT_VALUE MEASUREMENT_UNIT RELATIONAL_OPERATOR TIME GENE_OR_PROTEIN 變異 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 系統管理 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 CASocialIns以Number CLIdentityCardNumber CNResidentIdentityCardNumber CreditCardNumber HRIdentityCardNumber HRNationalIDNumber HRPersonalIdentificationNumber HRPersonalIdentificationOIBNumberV2 CYIdentityCard CYTaxIdentificationNumber CZPersonalIdentityNumber CZPersonalIdentityV2 DKPersonalIdentificationNumber DKPersonalIdentificationV2 DrugEnforcementAgencyNumber EEPersonalIdentificationCode EUDebitCardNumber EUDriversLicenseNumber EUGPCoordinates EUNationalIdentificationNumber EUPassportNumber EUSocialSecurityNumber EUTaxIdentificationNumber FIEuropeanHealthNumber FINationalID FINationalIDV2 FIPassportNumber FRDriversLicenseNumber FRHealthInsuniNumber 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 JPSocialInsocialNumber 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 UKNationalInsnationalNumber 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 網欄位型別。

共用方式為

@azure/ai-text-analytics package

類別

介面

類型別名

服務支援的已知值

服務支援的已知值

服務支援的已知值

服務支援的已知值

服務支援的已知值

服務支援的已知值

列舉

其他資源