@azure/ai-language-text package
クラス
| AzureKeyCredential |
基になるキー値の更新をサポートする静的キーベースの資格情報。 |
| TextAnalysisClient |
Azure Cognitive Language Service のテキスト分析機能を操作するためのクライアント。 クライアントには、言語リソースのエンドポイントと、API キーや AAD などの認証方法が必要です。 API キーとエンドポイントは、Azure portal の [言語リソース] ページにあります。 リソースの [キーとエンドポイント] ページの [リソース管理] に表示されます。 認証の例:API キー
Azure Active DirectoryAzure Active Directory での認証の詳細については、
|
インターフェイス
| AbstractiveSummarizationAction |
抽象要約アクションのオプション。 |
| AbstractiveSummarizationBatchAction |
抽象要約バッチ アクションのオプション。 |
| AbstractiveSummarizationSuccessResult |
1 つのドキュメントに対する抽象要約アクションの結果。そのドキュメントで識別された概要のコレクションが含まれます。 |
| AbstractiveSummary |
特定のドキュメントのコンテキストを持つ単一の概要を表すオブジェクト。 |
| ActionCommon |
すべてのアクションに共通の構成。 |
| ActionCustom |
カスタム モデルを使用するすべてのアクションに共通の構成。 |
| ActionMetadata |
アクションメタデータ。 |
| ActionPrebuilt |
事前構築済みモデルを使用するすべてのアクションに共通する構成。 |
| AnalyzeBatchActionCommon |
すべてのバッチ アクションに共通のオプション。 |
| AnalyzeBatchOperationMetadata |
beginAnalyzeBatch によって開始実行時間の長い操作のメタデータ。 |
| AnalyzeBatchOperationState |
ポーリングの分析開始操作の状態。 |
| AssessmentSentiment |
予測されたセンチメント、信頼度スコア、およびターゲットの評価に関するその他の情報を含むオブジェクト。 たとえば、"The food is good" という文では、ターゲットの 'food' の評価は 'good' です。 |
| BatchActionErrorResult |
バッチ分析アクションのエラー。 |
| BatchActionState |
バッチ処理されたアクションの状態 |
| BatchActionSuccessResult |
バッチ処理された成功したアクションの状態。 |
| BeginAnalyzeBatchOptions |
分析アクションの開始操作のオプション。 |
| ClassificationCategory |
カスタム分類ドキュメントの単一カテゴリ アクションによる分類結果 |
| CustomActionMetadata |
カスタム アクションメタデータ。 |
| CustomEntityRecognitionAction |
カスタム エンティティ タスクでサポートされているパラメーター。 |
| CustomEntityRecognitionBatchAction |
カスタム エンティティ認識バッチ アクションのオプション。 |
| CustomEntityRecognitionSuccessResult |
1 つのドキュメントで識別されたエンティティのコレクションを含む、1 つのドキュメントに対するカスタム エンティティ認識アクションの結果。 |
| CustomMultiLabelClassificationAction |
複数ラベル分類のカスタム アクションのオプション |
| CustomMultiLabelClassificationBatchAction |
カスタムの複数ラベル分類バッチ アクションのオプション。 |
| CustomMultiLabelClassificationSuccessResult |
分類の結果を含む、複数のドキュメントに対する複数ラベル分類アクションが成功した結果。 |
| CustomSingleLabelClassificationAction |
単一ラベル分類のカスタム アクションのオプション |
| CustomSingleLabelClassificationBatchAction |
カスタムの単一ラベル分類バッチ アクションのオプション。 |
| CustomSingleLabelClassificationSuccessResult |
分類の結果を含む、1 つのドキュメントに対する単一ラベル分類アクションが成功した結果。 |
| DetectedLanguage |
言語サービスによって識別されるドキュメントの言語に関する情報。 |
| DocumentWarning |
ドキュメントの処理中に発生した警告を表します。 |
| Entity |
型の分類内で分類されるエンティティとして識別される単語または語句。 言語サービスによって認識されるカテゴリのセットについては、https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories で説明されています。 |
| EntityDataSource |
特定のエンティティ カタログへの医療エンティティの参照を表す型。 |
| EntityLinkingAction |
エンティティ リンク アクションのオプション。 |
| EntityLinkingBatchAction |
バッチ アクションをリンクするエンティティのオプション。 |
| EntityLinkingSuccessResult |
1 つのドキュメントに対するエンティティ リンク アクションの結果。そのドキュメントで識別された LinkedEntity オブジェクトのコレクションが含まれます。 |
| EntityRecognitionAction |
エンティティ認識アクションのオプション。 |
| EntityRecognitionBatchAction |
エンティティ認識バッチ アクションのオプション。 |
| EntityRecognitionSuccessResult |
1 つのドキュメントに対するエンティティ認識アクションの結果。そのドキュメントで識別 Entity オブジェクトのコレクションが含まれます。 |
| ExtractiveSummarizationAction |
抽出要約タスクでサポートされているパラメーター。 |
| ExtractiveSummarizationBatchAction |
抽出要約バッチ アクションのオプション。 |
| ExtractiveSummarizationSuccessResult |
1 つのドキュメントに対する抽出要約アクションの結果。そのドキュメントで識別された概要のコレクションが含まれます。 |
| HealthcareAction |
医療タスクでサポートされているパラメーター。 |
| HealthcareAssertion |
医療エンティティに関するメタデータを記述するオブジェクト (仮説か条件付きかなど)。 |
| HealthcareBatchAction |
医療バッチ アクションのオプション。 |
| HealthcareEntity |
エッジがソース ノードとターゲット ノード間の特定の種類のリレーションシップである有向グラフ内のノードとして表される医療エンティティ。 |
| HealthcareEntityRelation |
2 つ以上の医療エンティティ間の関係。 |
| HealthcareEntityRelationRole |
関係において特定の役割を果たす医療エンティティ。 |
| HealthcareSuccessResult |
1 つのドキュメントに対して成功した医療分析アクションの結果。 |
| KeyPhraseExtractionAction |
キー フレーズ認識アクションのオプション。 |
| KeyPhraseExtractionBatchAction |
キー フレーズ抽出バッチ アクションのオプション。 |
| KeyPhraseExtractionSuccessResult |
1 つのドキュメントで識別されるキー フレーズのコレクションを含む、1 つのドキュメントに対するキー フレーズ抽出アクションの結果。 |
| LanguageDetectionAction |
言語検出アクションのオプション。 |
| LanguageDetectionInput |
言語検出操作への入力。 このオブジェクトは、ドキュメントの言語予測モデルがドキュメントの言語を検出するのに役立つ一意のドキュメント ID と、ドキュメントのフルテキストと、ドキュメントの原産国を示すヒントを指定します。 |
| LanguageDetectionSuccessResult |
ドキュメントが書き込まれる言語の予測を含む、1 つのドキュメントに対する言語検出アクションの結果。 |
| LinkedEntity |
正式な (あいまいでない) 名前や、ソース データベース内のエンティティ情報へのリンクなど、データベース内で既知のエンティティとして識別される単語または語句。 |
| Match |
言語モデルによって識別されるリンクされたエンティティを参照するドキュメント内の特定の部分文字列の詳細。 |
| Opinion |
縮小されたオピニオン オブジェクトは、文から抽出したオピニオンを表します。 これらの評価が対象となるターゲットと、実際の評価自体の両方で構成されます。 |
| PiiEntityRecognitionAction |
Pii エンティティ認識アクションのオプション。 |
| PiiEntityRecognitionBatchAction |
pii エンティティ認識バッチ アクションのオプション。 |
| PiiEntityRecognitionSuccessResult |
1 つのドキュメントに対する pii エンティティ認識アクションの結果。そのドキュメントで識別 オブジェクト Entity のコレクションが含まれます。 |
| PollerLike |
ユーザーが操作する必要がある最小限の API のみを公開することを目的としたポーリングャーの抽象表現。 |
| RestoreAnalyzeBatchPollerOptions |
分析アクションの開始操作のオプション。 |
| SentenceSentiment |
特定の範囲のテキストに対する予測センチメント。 テキストセンチメントの詳細については、https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overviewを参照してください。 |
| SentimentAnalysisAction |
感情分析アクションのオプション。 |
| SentimentAnalysisBatchAction |
感情分析バッチ アクションのオプション。 |
| SentimentAnalysisSuccessResult |
1 つのドキュメントに対するセンチメント分析アクションの結果。各文と完全なドキュメントの予測センチメントが含まれます。 |
| SentimentConfidenceScores |
すべてのセンチメント クラス (正、中立、負) の 0 から 1 の信頼度スコアを表します。 |
| SummaryContext |
概要のコンテキスト。 |
| SummarySentence |
抽出された概要の一部である文。 |
| TargetConfidenceScores |
すべてのセンチメント クラス (正と負) の信頼度スコアを表します。 |
| TargetSentiment |
TargetSentiment には、予測されたセンチメント、信頼度スコア、および製品のターゲットに関するその他の情報が含まれます。 製品/サービスのターゲットは、その製品/サービスの重要なコンポーネントです。 たとえば、"The food at Hotel Foo is good"では、"food" は "Hotel Foo" のターゲットです。 |
| TextAnalysisClientOptions |
TextAnalysisClientの構成オプション。 |
| TextAnalysisError |
API エラーを記述する型。 |
| TextAnalysisErrorResult |
1 つのドキュメントに対応するアクションのエラー結果の基本型。 |
| TextAnalysisOperationOptions |
すべての操作に共通のオプション。 |
| TextAnalysisSuccessResult |
1 つの入力ドキュメントに対応するアクションの結果の基本型。 |
| TextDocumentBatchStatistics |
要求で includeStatistics=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
| TextDocumentInput |
言語サービスによって分析される個々のテキスト ドキュメントを表すオブジェクト。 ドキュメントには、一意のドキュメント ID、ドキュメントのフルテキスト、およびドキュメントのテキストの言語が含まれています。 |
| TextDocumentStatistics |
要求で includeStatistics=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
型エイリアス
| AbstractiveSummarizationBatchResult |
抽象要約バッチ アクションの結果。 |
| AbstractiveSummarizationErrorResult |
1 つのドキュメントに対する抽象要約アクションによるエラーの結果。 |
| AbstractiveSummarizationResult |
1 つのドキュメントに対する抽象要約アクションの結果。 |
| AnalyzeActionName |
analyze メソッドでサポートされるアクションの種類。 |
| AnalyzeActionParameters |
$AnalyzeActionNamesのすべてのアクションのパラメーターの種類。 |
| AnalyzeBatchAction |
アクションのバッチ。 |
| AnalyzeBatchActionName |
beginAnalyzeBatch メソッド でサポートされるアクションの種類。 |
| AnalyzeBatchPoller |
beginAnalyzeBatch によって開始された実行時間の長い操作ポーリングするポーリングプログラム。 |
| AnalyzeBatchResult |
アクションのバッチの結果。 |
| AnalyzeResult |
$AnalyzeActionNamesのすべてのアクションの結果の種類。 |
| BatchActionResult |
バッチ処理されたアクションの結果。 |
| CustomEntityRecognitionBatchResult |
カスタム エンティティ認識バッチ アクションの結果。 |
| CustomEntityRecognitionErrorResult |
1 つのドキュメントに対するカスタム エンティティ認識アクションの結果としてエラーが発生しました。 |
| CustomEntityRecognitionResult |
1 つのドキュメントに対するカスタム エンティティ認識アクションの結果。 |
| CustomMultiLabelClassificationBatchResult |
カスタムの複数ラベル分類バッチ アクションの結果。 |
| CustomMultiLabelClassificationErrorResult |
複数のドキュメントに対する複数ラベル分類アクションの結果としてエラーが発生しました。 |
| CustomMultiLabelClassificationResult |
複数のドキュメントに対する複数ラベル分類アクションの結果。 |
| CustomSingleLabelClassificationBatchResult |
カスタムの単一ラベル分類バッチ アクションの結果。 |
| CustomSingleLabelClassificationErrorResult |
1 つのドキュメントに対する単一ラベル分類アクションによるエラーの結果。 |
| CustomSingleLabelClassificationResult |
1 つのドキュメントに対する単一ラベル分類アクションの結果。 |
| DocumentSentimentLabel |
DocumentSentimentLabel の値を定義します。 |
| EntityAssociation |
EntityAssociation の値を定義します。 |
| EntityCertainty |
EntityCertainty の値を定義します。 |
| EntityConditionality |
EntityConditionality の値を定義します。 |
| EntityLinkingBatchResult |
バッチ アクションをリンクするエンティティの結果。 |
| EntityLinkingErrorResult |
1 つのドキュメントに対するエンティティ リンク アクションの結果としてエラーが発生しました。 |
| EntityLinkingResult |
1 つのドキュメントに対するエンティティ リンク アクションの結果。 |
| EntityRecognitionBatchResult |
エンティティ認識バッチ アクションの結果。 |
| EntityRecognitionErrorResult |
1 つのドキュメントに対するエンティティ認識アクションの結果としてエラーが発生しました。 |
| EntityRecognitionResult |
1 つのドキュメントに対するエンティティ認識アクションの結果。 |
| ExtractiveSummarizationBatchResult |
抽出要約バッチ アクションの結果。 |
| ExtractiveSummarizationErrorResult |
1 つのドキュメントに対する抽出要約アクションによるエラーの結果。 |
| ExtractiveSummarizationOrderingCriteria |
ExtractiveSummarizationOrderingCriteria の値を定義します。 サービスでサポートされている既知の値
オフセット: テキスト内の外観順に結果を並べ替える必要があることを示します。 |
| ExtractiveSummarizationResult |
1 つのドキュメントに対する抽出要約アクションの結果。 |
| HealthcareBatchResult |
医療バッチ アクションの結果。 |
| HealthcareEntityCategory |
HealthcareEntityCategory の値を定義します。 サービスでサポートされている既知の値
BodyStructure |
| HealthcareEntityRelationRoleType |
医療エンティティが関係で果たすことができるさまざまなロールの種類。 |
| HealthcareErrorResult |
1 つのドキュメントに対する医療分析アクションによるエラーの結果。 |
| HealthcareResult |
1 つのドキュメントに対する医療分析アクションの結果。 |
| KeyPhraseExtractionBatchResult |
キー フレーズ抽出バッチ アクションの結果。 |
| KeyPhraseExtractionErrorResult |
1 つのドキュメントに対するキー フレーズ抽出アクションによるエラーの結果。 |
| KeyPhraseExtractionResult |
1 つのドキュメントに対するセンチメント分析アクションの結果。 |
| LanguageDetectionErrorResult |
1 つのドキュメントに対する言語検出アクションの結果としてエラーが発生しました。 |
| LanguageDetectionResult |
1 つのドキュメントに対する言語検出アクションの結果。 |
| PagedAnalyzeBatchResult |
beginAnalyzeBatch 操作のページングされた結果。 |
| PiiEntityCategory |
PiiEntityCategory の値を定義します。 サービスでサポートされている既知の値
ABARoutingNumber |
| PiiEntityDomain |
PiiEntityDomain の値を定義します。 サービスでサポートされている既知の値
phi: Personal Health Information ドメイン内のエンティティを編集する必要があることを示します。 |
| PiiEntityRecognitionBatchResult |
pii エンティティ認識バッチ アクションの結果。 |
| PiiEntityRecognitionErrorResult |
1 つのドキュメントに対する pii エンティティ認識アクションによるエラーの結果。 |
| PiiEntityRecognitionResult |
1 つのドキュメントに対するエンティティ認識アクションの結果。 |
| RelationType |
RelationType の値を定義します。 サービスでサポートされている既知の値
省略形 |
| SentenceSentimentLabel |
SentenceSentimentLabel の値を定義します。 |
| SentimentAnalysisBatchResult |
感情分析バッチ アクションの結果。 |
| SentimentAnalysisErrorResult |
1 つのドキュメントに対するセンチメント分析アクションによるエラーの結果。 |
| SentimentAnalysisResult |
1 つのドキュメントに対するセンチメント分析アクションの結果。 |
| StringIndexType |
StringIndexType の値を定義します。 サービスでサポートされている既知の値
TextElements_v8: 返されるオフセット値と長さの値は、Unicode 8.0.0 標準を確認する TextElements (Graphemes および Grapheme クラスター) に対応します。 アプリケーションが .Net Framework または .Net Core で記述されていて、StringInfo を使用する場合は、このオプションを使用します。 |
| TokenSentimentLabel |
TokenSentimentLabel の値を定義します。 |
| WarningCode |
WarningCode の値を定義します。 サービスでサポートされている既知の値
LongWordsInDocument |
列挙型
| KnownErrorCode |
サービスが受け入れる KnownErrorCode の既知の値。 |
| KnownExtractiveSummarizationOrderingCriteria | |
| KnownHealthcareEntityCategory | |
| KnownInnerErrorCode |
サービスが受け入れる KnownInnerErrorCode の既知の値。 |
| KnownPiiEntityCategory |
PiiEntityCategory の既知の値は、サービスが受け入れる です。 |
| KnownPiiEntityDomain |
PiiEntityDomain 既知の値は、サービスが受け入れる。 |
| KnownRelationType |
RelationType 既知の値は、サービスが受け入れる。 |
| KnownStringIndexType |
サービス 受け入れる StringIndexType の既知の値。 |
変数
| Analyze |
analyze メソッドでサポートされるアクションの種類。 |
| Analyze |
beginAnalyzeBatch メソッド でサポートされるアクションの種類。 |
| Known |
TextAnalysisErrorの可能なエラーコードの列挙。 |
Variable Details
AnalyzeActionNames
analyze メソッドでサポートされるアクションの種類。
AnalyzeActionNames: { EntityLinking: "EntityLinking", EntityRecognition: "EntityRecognition", KeyPhraseExtraction: "KeyPhraseExtraction", LanguageDetection: "LanguageDetection", PiiEntityRecognition: "PiiEntityRecognition", SentimentAnalysis: "SentimentAnalysis" }
型
{ EntityLinking: "EntityLinking", EntityRecognition: "EntityRecognition", KeyPhraseExtraction: "KeyPhraseExtraction", LanguageDetection: "LanguageDetection", PiiEntityRecognition: "PiiEntityRecognition", SentimentAnalysis: "SentimentAnalysis" }
AnalyzeBatchActionNames
beginAnalyzeBatch メソッド でサポートされるアクションの種類。
AnalyzeBatchActionNames: { AbstractiveSummarization: "AbstractiveSummarization", CustomEntityRecognition: "CustomEntityRecognition", CustomMultiLabelClassification: "CustomMultiLabelClassification", CustomSingleLabelClassification: "CustomSingleLabelClassification", EntityLinking: "EntityLinking", EntityRecognition: "EntityRecognition", ExtractiveSummarization: "ExtractiveSummarization", Healthcare: "Healthcare", KeyPhraseExtraction: "KeyPhraseExtraction", PiiEntityRecognition: "PiiEntityRecognition", SentimentAnalysis: "SentimentAnalysis" }
型
{ AbstractiveSummarization: "AbstractiveSummarization", CustomEntityRecognition: "CustomEntityRecognition", CustomMultiLabelClassification: "CustomMultiLabelClassification", CustomSingleLabelClassification: "CustomSingleLabelClassification", EntityLinking: "EntityLinking", EntityRecognition: "EntityRecognition", ExtractiveSummarization: "ExtractiveSummarization", Healthcare: "Healthcare", KeyPhraseExtraction: "KeyPhraseExtraction", PiiEntityRecognition: "PiiEntityRecognition", SentimentAnalysis: "SentimentAnalysis" }
KnownTextAnalysisErrorCode
TextAnalysisErrorの可能なエラーコードの列挙。
KnownTextAnalysisErrorCode: { AzureCognitiveSearchIndexLimitReached: KnownErrorCode.AzureCognitiveSearchIndexLimitReached, AzureCognitiveSearchIndexNotFound: KnownErrorCode.AzureCognitiveSearchIndexNotFound, AzureCognitiveSearchNotFound: KnownInnerErrorCode.AzureCognitiveSearchNotFound, AzureCognitiveSearchThrottling: KnownInnerErrorCode.AzureCognitiveSearchThrottling, Conflict: KnownErrorCode.Conflict, EmptyRequest: KnownInnerErrorCode.EmptyRequest, ExtractionFailure: KnownInnerErrorCode.ExtractionFailure, Forbidden: KnownErrorCode.Forbidden, InternalServerError: KnownErrorCode.InternalServerError, InvalidArgument: KnownErrorCode.InvalidArgument, InvalidCountryHint: KnownInnerErrorCode.InvalidCountryHint, InvalidDocument: KnownInnerErrorCode.InvalidDocument, InvalidDocumentBatch: KnownInnerErrorCode.InvalidDocumentBatch, InvalidParameterValue: KnownInnerErrorCode.InvalidParameterValue, InvalidRequest: KnownInnerErrorCode.InvalidRequest, InvalidRequestBodyFormat: KnownInnerErrorCode.InvalidRequestBodyFormat, KnowledgeBaseNotFound: KnownInnerErrorCode.KnowledgeBaseNotFound, MissingInputDocuments: KnownInnerErrorCode.MissingInputDocuments, ModelVersionIncorrect: KnownInnerErrorCode.ModelVersionIncorrect, NotFound: KnownErrorCode.NotFound, OperationNotFound: KnownErrorCode.OperationNotFound, ProjectNotFound: KnownErrorCode.ProjectNotFound, QuotaExceeded: KnownErrorCode.QuotaExceeded, ServiceUnavailable: KnownErrorCode.ServiceUnavailable, Timeout: KnownErrorCode.Timeout, TooManyRequests: KnownErrorCode.TooManyRequests, Unauthorized: KnownErrorCode.Unauthorized, UnsupportedLanguageCode: KnownInnerErrorCode.UnsupportedLanguageCode, Warning: KnownErrorCode.Warning }
型
{ AzureCognitiveSearchIndexLimitReached: KnownErrorCode.AzureCognitiveSearchIndexLimitReached, AzureCognitiveSearchIndexNotFound: KnownErrorCode.AzureCognitiveSearchIndexNotFound, AzureCognitiveSearchNotFound: KnownInnerErrorCode.AzureCognitiveSearchNotFound, AzureCognitiveSearchThrottling: KnownInnerErrorCode.AzureCognitiveSearchThrottling, Conflict: KnownErrorCode.Conflict, EmptyRequest: KnownInnerErrorCode.EmptyRequest, ExtractionFailure: KnownInnerErrorCode.ExtractionFailure, Forbidden: KnownErrorCode.Forbidden, InternalServerError: KnownErrorCode.InternalServerError, InvalidArgument: KnownErrorCode.InvalidArgument, InvalidCountryHint: KnownInnerErrorCode.InvalidCountryHint, InvalidDocument: KnownInnerErrorCode.InvalidDocument, InvalidDocumentBatch: KnownInnerErrorCode.InvalidDocumentBatch, InvalidParameterValue: KnownInnerErrorCode.InvalidParameterValue, InvalidRequest: KnownInnerErrorCode.InvalidRequest, InvalidRequestBodyFormat: KnownInnerErrorCode.InvalidRequestBodyFormat, KnowledgeBaseNotFound: KnownInnerErrorCode.KnowledgeBaseNotFound, MissingInputDocuments: KnownInnerErrorCode.MissingInputDocuments, ModelVersionIncorrect: KnownInnerErrorCode.ModelVersionIncorrect, NotFound: KnownErrorCode.NotFound, OperationNotFound: KnownErrorCode.OperationNotFound, ProjectNotFound: KnownErrorCode.ProjectNotFound, QuotaExceeded: KnownErrorCode.QuotaExceeded, ServiceUnavailable: KnownErrorCode.ServiceUnavailable, Timeout: KnownErrorCode.Timeout, TooManyRequests: KnownErrorCode.TooManyRequests, Unauthorized: KnownErrorCode.Unauthorized, UnsupportedLanguageCode: KnownInnerErrorCode.UnsupportedLanguageCode, Warning: KnownErrorCode.Warning }