@azure/ai-text-analytics package

クラス

AzureKeyCredential	基になるキー値の更新をサポートする静的キーベースの資格情報。
TextAnalyticsClient	Azure Text Analyticsと対話するためのクライアント クラス。

インターフェイス

AnalysisPollOperationState	分析ポーリング操作の状態を表すインターフェイス。
AnalyzeActionsOperationMetadata	beginAnalyzeActions 操作のメタデータ。
AnalyzeActionsOperationState	ポーリング操作の分析を開始するの状態。
AnalyzeActionsResult	アクションの分析操作の結果。
AnalyzeHealthcareEntitiesResultArray	AnalyzeHealthcareEntitiesResult の配列
AnalyzeHealthcareEntitiesSuccessResult	1 つのドキュメントの医療操作が成功した結果。
AnalyzeHealthcareOperationState	の状態は、医療ポーリング操作の分析を開始します。
AnalyzeSentimentAction	感情分析アクションのオプション。
AnalyzeSentimentActionSuccessResult	成功した感情分析アクションの結果。
AnalyzeSentimentOptions	感情分析操作のオプション。
AnalyzeSentimentResultArray	入力ドキュメントの AnalyzeSentimentResult バッチに対応し、バッチ操作に関する情報で注釈が付けられたオブジェクトの配列。
AnalyzeSentimentSuccessResult	1 つのドキュメントに対するセンチメント分析操作の結果。各文と完全なドキュメントの予測センチメントが含まれます。
AssessmentSentiment	AssessmentSentiment には、予測されたセンチメント、信頼度スコア、およびターゲットの評価に関するその他の情報が含まれます。 たとえば、"The food is good" という文では、ターゲットの 'food' の評価は "good" です。
BeginAnalyzeActionsOptions	アクションの分析を開始する操作のオプション。
BeginAnalyzeHealthcareEntitiesOptions	[医療エンティティの分析を開始する] 操作のオプション。
CategorizedEntity	カテゴリ分類に関する情報を含むテキスト分析のエンティティ。
DetectLanguageInput	言語検出操作への入力。 このオブジェクトは、ドキュメントの言語を検出する際にテキスト分析予測モデルを支援するために、ドキュメントの一意のドキュメント ID とドキュメントのフルテキストと、ドキュメントの原産国を示すヒントを指定します。
DetectLanguageOptions	言語検出操作のオプション。
DetectLanguageResultArray	入力ドキュメントの DetectLanguageResult バッチに対応し、バッチ操作に関する情報で注釈が付けられたオブジェクトの配列。
DetectLanguageSuccessResult	ドキュメントが書き込まれる言語の予測を含む、1 つのドキュメントに対する言語検出操作の結果。
DetectedLanguage	Text Analytics サービスによって識別されるドキュメントの言語に関する情報。
Entity	型の分類内に分類されるエンティティとして識別される単語または語句。 Text Analytics サービスによって認識されるカテゴリのセットについては、 でhttps://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types説明されています。
EntityAssertion
EntityDataSource	医療エンティティの特定のエンティティ カタログへの参照を表す型。
ExtractKeyPhrasesAction	キー フレーズ認識アクションのオプション。
ExtractKeyPhrasesActionSuccessResult	成功した抽出キー フレーズ アクションの結果。
ExtractKeyPhrasesOptions	キー フレーズの抽出操作のオプション。
ExtractKeyPhrasesResultArray	入力ドキュメントの ExtractKeyPhrasesResult バッチに対応し、バッチ操作に関する情報で注釈が付けられたオブジェクトの配列。
ExtractKeyPhrasesSuccessResult	1 つのドキュメントで識別されたキー フレーズのコレクションを含む、1 つのドキュメントに対するキー フレーズの抽出操作の結果。
HealthcareEntity	エッジがソース ノードとターゲット ノード間の特定の種類のリレーションシップである有向グラフのノードとして表される医療エンティティ。
HealthcareEntityRelation	2 つ以上の医療エンティティ間の関係。
HealthcareEntityRelationRole	関係で特定の役割を果たす医療エンティティ。
LinkedEntity	正式な (あいまいでない) 名前やソース データベース内のエンティティ情報へのリンクなど、データベース内で既知のエンティティとして識別される単語または語句。
Match	Text Analytics モデルによって識別されるリンクされたエンティティを参照するドキュメント内の特定の部分文字列の詳細。
OperationMetadata	分析ポーリング操作のメタデータ情報。
Opinion	縮小されたオピニオン オブジェクトは、文から抽出した意見を表します。 これは、これらの評価に関するターゲットと、実際の評価自体の両方で構成されます。
PagedAnalyzeActionsResult	要求されたアクションの結果を反復処理するページ反復子として表される分析アクション操作の結果。
PagedAnalyzeHealthcareEntitiesResult	ページ反復子として表される医療操作の結果。ドキュメントごとに結果を反復処理することも、byPage() を使用してドキュメントのページを反復処理することもできます。
PiiEntity	検出された PII の種類に関する情報を含む PII 認識からのエンティティ。
RecognizeCategorizedEntitiesAction	エンティティ認識アクションのオプション。
RecognizeCategorizedEntitiesActionSuccessResult	正常に認識されたカテゴリ化されたエンティティ アクションの結果。
RecognizeCategorizedEntitiesOptions	エンティティ認識操作のオプション。
RecognizeCategorizedEntitiesResultArray	入力ドキュメントの RecognizeCategorizedEntitiesResult バッチに対応し、バッチ操作に関する情報で注釈が付けられたオブジェクトの配列。
RecognizeCategorizedEntitiesSuccessResult	1 つのドキュメントに対するエンティティ認識操作の結果。そのドキュメントで識別されたオブジェクトの Entity コレクションが含まれます。
RecognizeLinkedEntitiesAction	エンティティ リンク アクションのオプション。
RecognizeLinkedEntitiesActionSuccessResult	成功したリンクエンティティの認識アクションの結果。
RecognizeLinkedEntitiesOptions	リンクされたエンティティの認識操作のオプション。
RecognizeLinkedEntitiesResultArray	入力ドキュメントの RecognizeLinkedEntitiesResult バッチに対応し、バッチ操作に関する情報で注釈が付けられたオブジェクトの配列。
RecognizeLinkedEntitiesSuccessResult	1 つのドキュメントに対するリンクされたエンティティの認識操作の結果。この操作には、そのドキュメントで識別されたオブジェクトの LinkedEntity コレクションが含まれます。
RecognizePiiEntitiesAction	Pii エンティティ認識アクションのオプション。
RecognizePiiEntitiesActionSuccessResult	成功した recognize pii エンティティ アクションの結果。
RecognizePiiEntitiesOptions	PII エンティティ認識操作のオプション。
RecognizePiiEntitiesResultArray	入力ドキュメントの RecognizePiiEntitiesResult バッチに対応し、バッチ操作に関する情報で注釈が付けられたオブジェクトのコレクション。
RecognizePiiEntitiesSuccessResult	1 つのドキュメントに対するエンティティ認識操作の結果。そのドキュメントで識別されたオブジェクトの 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 には、予測されたセンチメント、信頼度スコア、および製品のターゲットに関するその他の情報が含まれます。 製品/サービスのターゲットは、その製品/サービスの重要なコンポーネントです。 たとえば、「ホテルフーの食べ物は良い」では、「食べ物」は「ホテルフー」のターゲットです。
TextAnalyticsAction	テキスト分析アクションの種類。
TextAnalyticsActionErrorResult	バッチ分析アクションのエラー。
TextAnalyticsActionSuccessState	成功したアクションの状態。
TextAnalyticsActions	入力ドキュメントに対して実行する analyze API のアクションのコレクションの説明。 ただし、現時点では、サービスはアクションの種類ごとに最大 1 つのアクションのみを受け入れます。
TextAnalyticsClientOptions	TextAnalytics API 要求の構成に使用されるクライアント オプション。
TextAnalyticsError	Text Analytics サービスからのエラーを説明する型。
TextAnalyticsErrorResult	1 つのドキュメントに対応するテキスト分析操作のエラー結果の基本型。
TextAnalyticsOperationOptions	すべてのテキスト分析操作に共通のオプション。
TextAnalyticsSuccessResult	1 つの入力ドキュメントに対応するテキスト分析操作の結果の基本型。
TextAnalyticsWarning	ドキュメントの処理中に発生した警告を表します。
TextDocumentBatchStatistics	要求で includeStatistics=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。
TextDocumentInput	Text Analytics サービスによって分析される個々のテキスト ドキュメントを表す オブジェクト。 ドキュメントには、一意のドキュメント ID、ドキュメントのフルテキスト、およびドキュメントのテキストの言語が含まれています。
TextDocumentStatistics	要求で includeStatistics=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。

型エイリアス

AnalyzeActionsPollerLike	実行時間の長い操作 (LRO) の分析アクションの開始の結果の種類。
AnalyzeHealthcareEntitiesErrorResult	1 つのドキュメントに対する医療操作の結果としてエラーが発生しました。
AnalyzeHealthcareEntitiesPollerLike	正常性の実行時間の長い操作 (LRO) の結果の種類
AnalyzeHealthcareEntitiesResult	1 つのドキュメントに対する医療操作の結果。
AnalyzeSentimentActionErrorResult	感情分析アクションのエラー。
AnalyzeSentimentActionResult	感情分析アクションの結果。
AnalyzeSentimentErrorResult	1 つのドキュメントに対するセンチメント分析操作の結果としてエラーが発生しました。
AnalyzeSentimentResult	1 つのドキュメントに対するセンチメント分析操作の結果。
DetectLanguageErrorResult	1 つのドキュメントに対するランゲージ検出操作のエラー結果。
DetectLanguageResult	1 つのドキュメントに対する言語検出操作の結果。
DocumentSentimentLabel	DocumentSentimentLabel の値を定義します。
EntityAssociation	関連付けの値を定義します。
EntityCertainty	Certainty の値を定義します。
EntityConditionality	条件性の値を定義します。
ErrorCode	Text Analytics サービスから返されたエラー コード。 次の値を指定できます。 エラーの詳細については、関連するエラーの message プロパティを参照してください。
ErrorCodeValue	ErrorCodeValue の値を定義します。 <xref:KnownErrorCodeValue> ErrorCodeValue と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。 サービスでサポートされている既知の値 InvalidRequest InvalidArgument InternalServerError ServiceUnavailable NotFound
ExtractKeyPhrasesActionErrorResult	キー フレーズ抽出アクションのエラー。
ExtractKeyPhrasesActionResult	キー フレーズ抽出アクションの結果。
ExtractKeyPhrasesErrorResult	1 つのドキュメントに対するキー フレーズの抽出操作の結果としてエラーが発生しました。
ExtractKeyPhrasesResult	1 つのドキュメントに対するキー フレーズの抽出操作の結果。
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 DosageOfMedication 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 組織 Email URL Age PhoneNumber IPAddress 日付 Person アドレス すべて [Default]
RecognizeCategorizedEntitiesActionErrorResult	カテゴリ化されたエンティティの認識アクションのエラー。
RecognizeCategorizedEntitiesActionResult	カテゴリ化されたエンティティの認識アクションの結果。
RecognizeCategorizedEntitiesErrorResult	1 つのドキュメントに対するエンティティ認識操作の結果としてエラーが発生しました。
RecognizeCategorizedEntitiesResult	1 つのドキュメントに対するエンティティ認識操作の結果。
RecognizeLinkedEntitiesActionErrorResult	リンクされたエンティティの認識アクションのエラー。
RecognizeLinkedEntitiesActionResult	リンクされたエンティティの認識アクションの結果。
RecognizeLinkedEntitiesErrorResult	1 つのドキュメントでリンクされたエンティティを認識する操作の結果としてエラーが発生しました。
RecognizeLinkedEntitiesResult	1 つのドキュメントに対するリンクされたエンティティの認識操作の結果。
RecognizePiiEntitiesActionErrorResult	pii エンティティ認識アクションのエラー。
RecognizePiiEntitiesActionResult	pii エンティティ認識アクションの結果。
RecognizePiiEntitiesErrorResult	1 つのドキュメントに対するエンティティ認識操作の結果としてエラーが発生しました。
RecognizePiiEntitiesResult	1 つのドキュメントに対するエンティティ認識操作の結果。
SentenceSentimentLabel	SentenceSentimentLabel の値を定義します。
StringIndexType	オフセットと長さのプロパティの計算に使用できる測定単位。
TextAnalyticsOperationStatus	State の値を定義します。
TokenSentimentValue	TokenSentimentValue の値を定義します。
WarningCode	WarningCode の値を定義します。 KnownWarningCode は WarningCode と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 LongWordsInDocument DocumentTruncated

列挙型

KnownHealthcareEntityCategory	サービスが受け入れる HealthcareEntityCategory の既知の値。
KnownInnerErrorCodeValue	サービスが受け入れる InnerErrorCodeValue の既知の値。
KnownWarningCode	サービスが受け入れる WarningCode の既知の値。
PiiEntityDomain	ユーザーが選択できる PII ドメインの種類。