Azure Cognitive Service for Language

  • リファレンス

Azure Cognitive Service for Language (以前の名称は「テキスト分析」) のコネクタにより、言語、感情分析、入力されたその他のテキストが検出されます。

このコネクタは、次の製品および地域で利用可能です。

サービス クラス リージョン
Logic Apps 標準 すべての Logic Apps 地域
Power Automate 標準 すべての Power Automate 地域
Power Apps - 該当なし
Contact
件名 マイクロソフト
URL https://gallery.cortanaanalytics.com/MachineLearningAPI/Text-Analytics-2
メール mlapi@microsoft.com
コネクタのメタデータ
パブリッシャー マイクロソフト
Web サイト https://azure.microsoft.com/services/cognitive-services/text-analytics/

注意

このコネクタは、以前は「Text Analytics」または「Microsoft Cognitive Services Text Analytics」と呼ばれていました。

この統合を使用するには、Azure ポータルの Cognitive Service リソース が必要です。 エンドポイントとアプリケーションを認証するためのキーを取得します。 接続するには、アカウント キーとサイトの URL を入力し、接続の作成 を選択します。 接続の運用コストについては、ここ で詳細を確認してください。

これで、この統合の使用を開始する準備が整いました。

Azure Active Directory との接続

AAD との接続を作成するには、アカウントに Cognitive Services ユーザー ロールを追加してアクセスする必要があります。 この接続を使用するには、サポートされている操作に Cognitive Services リソースに関連付けられている一意のサブドメインを入力する必要があります。

AAD 認証でサポートされていない操作

AAD 認証を使用する場合、V4 アクションのみがサポートされています。 非推奨アクションは引き続き Access Key 認証で機能しますが、AAD 接続で使用すると失敗します。

接続の作成

コネクタは、次の認証タイプをサポートしています:
API キー ApiKey すべての地域 共有可能
既定 [非推奨] このオプションは、明示的な認証の種類を持たない古い接続専用に対してのみ使用され、下位互換性を保つためにのみ提供されます。 すべての地域 共有不可

API キー

認証 ID: keyBasedAuth

適用できるもの: すべての領域

ApiKey

これは共有可能な接続です。 Power App が他のユーザーと共有されている場合、接続も共有されます。 詳細については、キャンバス アプリのコネクタの概要 - Power Apps | Microsoft Docs を参照してください

件名 タイプ 内容 必要
アカウント キー securestring Cognitive Services アカウント キー 真
サイトの URL 文字列 ルート サイト URL (例: https://westus.api.cognitive.microsoft.com)

既定 [非推奨]

適用できるもの: すべての領域

このオプションは、明示的な認証の種類を持たない古い接続専用に対してのみ使用され、下位互換性を保つためにのみ提供されます。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名称 タイプ 内容 必要
アカウント キー securestring Cognitive Services アカウント キー 真
サイトの URL 文字列 ルート サイト URL です (例: https://westus.api.cognitive.microsoft.com)。 指定しない場合、サイトの URL は既定で https://westus.api.cognitive.microsoft.com になります。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し120060 秒

アクション

エンティティ [非推奨]

このアクションは非推奨になりました。 代わりに名前付きエンティティの認識 (V4) を使用してください。

指定されたドキュメント内の既知のエンティティと一般的な名前付きエンティティ (「Person」、「Location」、「Organization」 など) の一覧を返します。
エンティティのリンク (V3.0)

API は、認識されたエンティティの一覧をリンクと共に既知のサポート情報に返します。 サポートする言語の一覧については、ご利用いただける言語を参照してください。
エンティティのリンク (V3.1) (プレビュー)

API は、認識されたエンティティの一覧をリンクと共に既知のサポート情報に返します。 サポートする言語の一覧については、ご利用いただける言語を参照してください。
エンティティのリンク (V4) (プレビュー)

API は、認識されたエンティティの一覧をリンクと共に既知のサポート情報に返します。 サポートする言語の一覧については、ご利用いただける言語を参照してください。
エンティティを検出する (V2) [非推奨]

このアクションは非推奨になりました。 代わりに名前付きエンティティの認識 (V4) を使用してください。

指定されたドキュメント内の既知のエンティティと一般的な名前付きエンティティ (「Person」、「Location」、「Organization」 など) の一覧を返します。
キー フレーズ (V2) [非推奨]

このアクションは非推奨になりました。 代わりにキー フレーズ (V4) を使用してください。

各ドキュメントの入力テキスト内で主な話題を示す文字列の一覧を返します。
キー フレーズ (V3.0)

API は入力テキスト内で主な話題を示す文字列の一覧を返します。 サポートする言語の一覧については、キー フレーズ抽出の言語サポートを参照してください。
キー フレーズ (V3.1) (プレビュー)

API は入力テキスト内で主な話題を示す文字列の一覧を返します。 サポートする言語の一覧については、キー フレーズ抽出の言語サポートを参照してください。
キー フレーズ (V4) (プレビュー)

API は入力テキスト内で主な話題を示す文字列の一覧を返します。 サポートする言語の一覧については、キー フレーズ抽出の言語サポートを参照してください。
キー フレーズ [非推奨]

このアクションは非推奨になりました。 代わりにキー フレーズ (V4) を使用してください。

入力テキスト内で主な話題を示す文字列の一覧を返します。
キー フレーズ [非推奨]

このアクションは非推奨になりました。 代わりにキー フレーズ (V4) を使用してください。

入力テキスト内で主な話題を示す文字列の一覧を返します。現在、次の言語がサポートされています: 英語、ドイツ語、スペイン語、日本語。
センチメント (V3.0)

API によって、ドキュメントおよびそこに含まれる各文のセンチメント予測のほか、各センチメント クラスのセンチメント スコア (肯定的、否定的、中立的) が返されます。 サポートされている言語の一覧については、感情分析と意見マイニング言語のサポートを参照してください。
センチメント (V3.1) (プレビュー)

API は、入力テキストの詳細な感情分析を返します。 ドキュメントのレベルから文や重要語句 (対象と評価) まで、複数の粒度レベルで分析を実行します。
センチメント (V4) (プレビュー)

API は、入力テキストの詳細な感情分析を返します。 ドキュメントのレベルから文や重要語句 (対象と評価) まで、複数の粒度レベルで分析を実行します。
センチメントの検出 (V2) [非推奨]

このアクションは非推奨になりました。 代わりにセンチメント (V4) を使用します。

各ドキュメントの 0 から 1 の数値スコアを返します。1 に近いスコアは肯定的センチメントを示し、0 に近いスコアは否定的センチメントを示します。
センチメントの検出 [非推奨]

このアクションは非推奨になりました。 代わりにセンチメント (V4) を使用します。

0 から 1 の数値スコアを返します。1 に近いスコアは肯定的センチメントを示し、0 に近いスコアは否定的センチメントを示します。
センチメントの検出 [非推奨]

このアクションは非推奨になりました。 代わりにセンチメント (V4) を使用します。

0 から 1 までの数値スコアを返します。1 に近いスコアは肯定的センチメントを示し、0 に近いスコアは否定的センチメントを示します。現在、次の言語がサポートされています: 英語、スペイン語、フランス語、ポルトガル語。
個人情報の検出 (V3.1)

API は、ドキュメント内の個人情報 ("SSN"、"銀行口座"など) を含むエンティティのリストを返します。 サポートされているエンティティ タイプのリストについては、サポートされている個人を特定できる情報 (PII) エンティティ カテゴリをチェックしてください。 サポートする言語の一覧については、Azure Cognitive Service for Language でサポートされている言語を参照してください。
個人情報の検出 (V4) (プレビュー)

API は、ドキュメント内の個人情報 ("SSN"、"銀行口座"など) を含むエンティティのリストを返します。 サポートされているエンティティ タイプのリストについては、サポートされている個人を特定できる情報 (PII) エンティティ カテゴリをチェックしてください。 サポートする言語の一覧については、Azure Cognitive Service for Language でサポートされている言語を参照してください。
名前付きエンティティの認識 (V3.0)

API は、指定されたドキュメント内の一般的な名前付きエンティティの一覧を返します。 サポートされているエンティティ タイプのリストについては、サポートされている固有表現認識 (NER) エンティティ カテゴリをチェックしてください。
名前付きエンティティの認識 (V3.1) (プレビュー)

API は、指定されたドキュメント内の一般的な名前付きエンティティの一覧を返します。 サポートされているエンティティ タイプのリストについては、サポートされている固有表現認識 (NER) エンティティ カテゴリをチェックしてください。
名前付きエンティティの認識 (V4) (プレビュー)

API は、指定されたドキュメント内の一般的な名前付きエンティティの一覧を返します。 サポートされているエンティティ タイプのリストについては、サポートされている固有表現認識 (NER) エンティティ カテゴリをチェックしてください。
言語の検出 (V2) [非推奨]

このアクションは非推奨になりました。 代わりに言語の検出 (V4) を使用してください。

各ドキュメントの検出された言語と 0 から 1 の数値スコアを返します。1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。合計 120 の言語がサポートされています。
言語の検出 (V3.0)

API は、検出された言語と 0 から 1 までの数値スコアを返します。 1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。 サポートする言語の一覧については、言語検出にご利用いただける言語を参照してください。
言語の検出 (V3.1) (プレビュー)

API は、検出された言語と 0 から 1 までの数値スコアを返します。 1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。 サポートする言語の一覧については、言語検出にご利用いただける言語を参照してください。
言語の検出 (V4) (プレビュー)

API は、検出された言語と 0 から 1 までの数値スコアを返します。 1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。 サポートする言語の一覧については、言語検出にご利用いただける言語を参照してください。
言語の検出 [非推奨]

このアクションは非推奨になりました。 代わりに言語の検出 (V4) を使用してください。

検出された言語と 0 から 1 の数値スコアを返します。1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。合計 120 の言語がサポートされています。
言語の検出 [非推奨]

このアクションは非推奨になりました。 代わりに言語の検出 (V4) を使用してください。

検出された言語と 0 から 1 の数値スコアを返します。1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。合計 120 の言語がサポートされています。

エンティティ [非推奨]

操作 ID:
DetectEntities

このアクションは非推奨になりました。 代わりに名前付きエンティティの認識 (V4) を使用してください。

指定されたドキュメント内の既知のエンティティと一般的な名前付きエンティティ (「Person」、「Location」、「Organization」 など) の一覧を返します。

パラメーター

名前 キー 必須 型 説明
テキスト
 text string

分析対象テキストです。
言語
 language string

これは、言語を表す 2 文字の ISO 639-1 表現です。 例: 英語には 「en」、スペイン語には 「es」 を使用する、などです。

戻り値

本文​​
EntitiesResult

エンティティのリンク (V3.0)

操作 ID:
EntitiesLinkingV3

API は、認識されたエンティティの一覧をリンクと共に既知のサポート情報に返します。 サポートする言語の一覧については、ご利用いただける言語を参照してください。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
統計を表示する
 showStats boolean

(任意) true に設定すると、応答に入力とドキュメント レベルの統計が含まれます。
ID
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
EntityLinkingResult

エンティティのリンク (V3.1) (プレビュー)

操作 ID:
EntitiesLinkingV3_1

API は、認識されたエンティティの一覧をリンクと共に既知のサポート情報に返します。 サポートする言語の一覧については、ご利用いただける言語を参照してください。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
stringIndexType
 stringIndexType string

(オプション) 文字列オフセットの解釈に使用する方法を指定します。 既定は Unicode v8.0.0 に基づくテキスト要素 (書記素) です。 詳細については https://aka.ms/text-analytics-offsets を参照してください
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
EntityLinkingResult

エンティティのリンク (V4) (プレビュー)

操作 ID:
EntitiesLinkingV4

API は、認識されたエンティティの一覧をリンクと共に既知のサポート情報に返します。 サポートする言語の一覧については、ご利用いただける言語を参照してください。

パラメーター

名前 キー 必須 型 説明
リソースのサブドメインや地域
 subdomain True string

Azure のサブドメインまたは地理的地域 (例: westus)
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
stringIndexType
 stringIndexType string

(オプション) 文字列オフセットの解釈に使用する方法を指定します。 既定は Unicode v8.0.0 に基づくテキスト要素 (書記素) です。 詳細については https://aka.ms/text-analytics-offsets を参照してください
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
EntityLinkingResult

エンティティを検出する (V2) [非推奨]

操作 ID:
DetectEntitiesV2

このアクションは非推奨になりました。 代わりに名前付きエンティティの認識 (V4) を使用してください。

指定されたドキュメント内の既知のエンティティと一般的な名前付きエンティティ (「Person」、「Location」、「Organization」 など) の一覧を返します。

パラメーター

名前 キー 必須 型 説明
ID
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

分析対象テキストです。
言語
 language string

これは、言語を表す 2 文字の ISO 639-1 表現です。 例: 英語には 「en」、スペイン語には 「es」 を使用する、などです。

戻り値

本文​​
EntitiesResults

キー フレーズ (V2) [非推奨]

操作 ID:
KeyPhrasesV3

このアクションは非推奨になりました。 代わりにキー フレーズ (V4) を使用してください。

各ドキュメントの入力テキスト内で主な話題を示す文字列の一覧を返します。

パラメーター

名前 キー 必須 型 説明
ID
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

分析対象テキストです。
言語
 language string

これは、言語を表す 2 文字の ISO 639-1 表現です。 例: 英語には 「en」、スペイン語には 「es」 を使用する、などです。

戻り値

本文​​
KeyPhraseResults

キー フレーズ (V3.0)

操作 ID:
KeyPhraseV3

API は入力テキスト内で主な話題を示す文字列の一覧を返します。 サポートする言語の一覧については、キー フレーズ抽出の言語サポートを参照してください。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
統計を表示する
 showStats boolean

(任意) true に設定すると、応答に入力とドキュメント レベルの統計が含まれます。
ID
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
KeyPhraseResultV3

キー フレーズ (V3.1) (プレビュー)

操作 ID:
KeyPhraseV3_1

API は入力テキスト内で主な話題を示す文字列の一覧を返します。 サポートする言語の一覧については、キー フレーズ抽出の言語サポートを参照してください。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
KeyPhraseResult

キー フレーズ (V4) (プレビュー)

操作 ID:
KeyPhraseV4

API は入力テキスト内で主な話題を示す文字列の一覧を返します。 サポートする言語の一覧については、キー フレーズ抽出の言語サポートを参照してください。

パラメーター

名前 キー 必須 型 説明
リソースのサブドメインや地域
 subdomain True string

Azure のサブドメインまたは地理的地域 (例: westus)
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
KeyPhraseResult

キー フレーズ [非推奨]

操作 ID:
KeyPhrasesV2

このアクションは非推奨になりました。 代わりにキー フレーズ (V4) を使用してください。

入力テキスト内で主な話題を示す文字列の一覧を返します。

パラメーター

名前 キー 必須 型 説明
テキスト
 text string

分析対象テキストです。
言語
 language string

これは、言語を表す 2 文字の ISO 639-1 表現です。 例: 英語には 「en」、スペイン語には 「es」 を使用する、などです。

戻り値

本文​​
KeyPhraseResult

キー フレーズ [非推奨]

操作 ID:
KeyPhrases

このアクションは非推奨になりました。 代わりにキー フレーズ (V4) を使用してください。

入力テキスト内で主な話題を示す文字列の一覧を返します。現在、次の言語がサポートされています: 英語、ドイツ語、スペイン語、日本語。

パラメーター

名前 キー 必須 型 説明
テキスト
 text string

分析対象テキストです。
言語
 language string

これは、言語を表す 2 文字の ISO 639-1 表現です。 例: 英語には 「en」、スペイン語には 「es」 を使用する、などです。

戻り値

本文​​
KeyPhraseResult

センチメント (V3.0)

操作 ID:
SentimentV3

API によって、ドキュメントおよびそこに含まれる各文のセンチメント予測のほか、各センチメント クラスのセンチメント スコア (肯定的、否定的、中立的) が返されます。 サポートされている言語の一覧については、感情分析と意見マイニング言語のサポートを参照してください。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
統計を表示する
 showStats boolean

(任意) true に設定すると、応答に入力とドキュメント レベルの統計が含まれます。
ID
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
SentimentResponse

センチメント (V3.1) (プレビュー)

操作 ID:
SentimentV3_1

API は、入力テキストの詳細な感情分析を返します。 ドキュメントのレベルから文や重要語句 (対象と評価) まで、複数の粒度レベルで分析を実行します。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
opinionMining
 opinionMining boolean

(オプション) true に設定すると、応答に、センチメント予測だけでなく、意見マイニング (アスペクトに基づくセンチメント分析) の結果も含めます。
stringIndexType
 stringIndexType string

(オプション) 文字列オフセットの解釈に使用する方法を指定します。 既定は Unicode v8.0.0 に基づくテキスト要素 (書記素) です。 詳細については https://aka.ms/text-analytics-offsets を参照してください
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
SentimentResponse

センチメント (V4) (プレビュー)

操作 ID:
SentimentV4

API は、入力テキストの詳細な感情分析を返します。 ドキュメントのレベルから文や重要語句 (対象と評価) まで、複数の粒度レベルで分析を実行します。

パラメーター

名前 キー 必須 型 説明
リソースのサブドメインや地域
 subdomain True string

Azure のサブドメインまたは地理的地域 (例: westus)
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
opinionMining
 opinionMining boolean

(オプション) true に設定すると、応答に、センチメント予測だけでなく、意見マイニング (アスペクトに基づくセンチメント分析) の結果も含めます。
stringIndexType
 stringIndexType string

(オプション) 文字列オフセットの解釈に使用する方法を指定します。 既定は Unicode v8.0.0 に基づくテキスト要素 (書記素) です。 詳細については https://aka.ms/text-analytics-offsets を参照してください
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
SentimentResponse

センチメントの検出 (V2) [非推奨]

操作 ID:
DetectSentimentV3

このアクションは非推奨になりました。 代わりにセンチメント (V4) を使用します。

各ドキュメントの 0 から 1 の数値スコアを返します。1 に近いスコアは肯定的センチメントを示し、0 に近いスコアは否定的センチメントを示します。

パラメーター

名前 キー 必須 型 説明
ID
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

分析対象テキストです。
言語
 language string

これは、言語を表す 2 文字の ISO 639-1 表現です。 例: 英語には 「en」、スペイン語には 「es」 を使用する、などです。

戻り値

本文​​
SentimentResults

センチメントの検出 [非推奨]

操作 ID:
DetectSentimentV2

このアクションは非推奨になりました。 代わりにセンチメント (V4) を使用します。

0 から 1 の数値スコアを返します。1 に近いスコアは肯定的センチメントを示し、0 に近いスコアは否定的センチメントを示します。

パラメーター

名前 キー 必須 型 説明
テキスト
 text string

分析対象テキストです。
言語
 language string

これは、言語を表す 2 文字の ISO 639-1 表現です。 例: 英語には 「en」、スペイン語には 「es」 を使用する、などです。

戻り値

本文​​
SentimentResult

センチメントの検出 [非推奨]

操作 ID:
DetectSentiment

このアクションは非推奨になりました。 代わりにセンチメント (V4) を使用します。

0 から 1 までの数値スコアを返します。1 に近いスコアは肯定的センチメントを示し、0 に近いスコアは否定的センチメントを示します。現在、次の言語がサポートされています: 英語、スペイン語、フランス語、ポルトガル語。

パラメーター

名前 キー 必須 型 説明
テキスト
 text string

分析対象テキストです。
言語
 language string

これは、言語を表す 2 文字の ISO 639-1 表現です。 例: 英語には 「en」、スペイン語には 「es」 を使用する、などです。

戻り値

本文​​
SentimentResult

個人情報の検出 (V3.1)

操作 ID:
EntitiesRecognitionPIIV3_1

API は、ドキュメント内の個人情報 ("SSN"、"銀行口座"など) を含むエンティティのリストを返します。 サポートされているエンティティ タイプのリストについては、サポートされている個人を特定できる情報 (PII) エンティティ カテゴリをチェックしてください。 サポートする言語の一覧については、Azure Cognitive Service for Language でサポートされている言語を参照してください。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
ドメイン
 domain string

(オプション) 指定すると、エンティティ カテゴリのサブセットのみを含むように PII ドメインを設定します。 指定できる値には、'PHI'、'none' が含まれます。
stringIndexType
 stringIndexType string

(オプション) 文字列オフセットの解釈に使用する方法を指定します。 既定は Unicode v8.0.0 に基づくテキスト要素 (書記素) です。 詳細については https://aka.ms/text-analytics-offsets を参照してください
piiCategories
 piiCategories array

(オプション) 返す PII カテゴリについて説明する
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
PiiResult

個人情報の検出 (V4) (プレビュー)

操作 ID:
EntitiesRecognitionPIIV4

API は、ドキュメント内の個人情報 ("SSN"、"銀行口座"など) を含むエンティティのリストを返します。 サポートされているエンティティ タイプのリストについては、サポートされている個人を特定できる情報 (PII) エンティティ カテゴリをチェックしてください。 サポートする言語の一覧については、Azure Cognitive Service for Language でサポートされている言語を参照してください。

パラメーター

名前 キー 必須 型 説明
リソースのサブドメインや地域
 subdomain True string

Azure のサブドメインまたは地理的地域 (例: westus)
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
ドメイン
 domain string

(オプション) 指定すると、エンティティ カテゴリのサブセットのみを含むように PII ドメインを設定します。 指定できる値には、'PHI'、'none' が含まれます。
stringIndexType
 stringIndexType string

(オプション) 文字列オフセットの解釈に使用する方法を指定します。 既定は Unicode v8.0.0 に基づくテキスト要素 (書記素) です。 詳細については https://aka.ms/text-analytics-offsets を参照してください
piiCategories
 piiCategories array

(オプション) 返す PII カテゴリについて説明する
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
PiiResult

名前付きエンティティの認識 (V3.0)

操作 ID:
EntitiesRecognitionGeneralV3

API は、指定されたドキュメント内の一般的な名前付きエンティティの一覧を返します。 サポートされているエンティティ タイプのリストについては、サポートされている固有表現認識 (NER) エンティティ カテゴリをチェックしてください。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
統計を表示する
 showStats boolean

(任意) true に設定すると、応答に入力とドキュメント レベルの統計が含まれます。
ID
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
EntitiesResultV3

名前付きエンティティの認識 (V3.1) (プレビュー)

操作 ID:
EntitiesRecognitionGeneralV3_1

API は、指定されたドキュメント内の一般的な名前付きエンティティの一覧を返します。 サポートされているエンティティ タイプのリストについては、サポートされている固有表現認識 (NER) エンティティ カテゴリをチェックしてください。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
stringIndexType
 stringIndexType string

(オプション) 文字列オフセットの解釈に使用する方法を指定します。 既定は Unicode v8.0.0 に基づくテキスト要素 (書記素) です。 詳細については https://aka.ms/text-analytics-offsets を参照してください
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
EntitiesResult

名前付きエンティティの認識 (V4) (プレビュー)

操作 ID:
EntitiesRecognitionGeneralV4

API は、指定されたドキュメント内の一般的な名前付きエンティティの一覧を返します。 サポートされているエンティティ タイプのリストについては、サポートされている固有表現認識 (NER) エンティティ カテゴリをチェックしてください。

パラメーター

名前 キー 必須 型 説明
リソースのサブドメインや地域
 subdomain True string

Azure のサブドメインまたは地理的地域 (例: westus)
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
stringIndexType
 stringIndexType string

(オプション) 文字列オフセットの解釈に使用する方法を指定します。 既定は Unicode v8.0.0 に基づくテキスト要素 (書記素) です。 詳細については https://aka.ms/text-analytics-offsets を参照してください
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

処理する入力テキストです。
言語
 language string

(オプション) これは、言語を表す 2 文字の ISO 639-1 表現です。 たとえば、英語には 「en」 を、スペイン語には 「es」 を使用する、などです。設定されていない場合は、既定では英語の 「en」 を使用します。

戻り値

本文​​
EntitiesResult

言語の検出 (V2) [非推奨]

操作 ID:
DetectLanguageV3

このアクションは非推奨になりました。 代わりに言語の検出 (V4) を使用してください。

各ドキュメントの検出された言語と 0 から 1 の数値スコアを返します。1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。合計 120 の言語がサポートされています。

パラメーター

名前 キー 必須 型 説明
ID
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string

分析対象テキストです。

戻り値

本文​​
LanguageResults

言語の検出 (V3.0)

操作 ID:
LanguagesV3

API は、検出された言語と 0 から 1 までの数値スコアを返します。 1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。 サポートする言語の一覧については、言語検出にご利用いただける言語を参照してください。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
統計を表示する
 showStats boolean

(任意) true に設定すると、応答に入力とドキュメント レベルの統計が含まれます。
ID
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string
countryHint
 countryHint string

戻り値

本文​​
LanguageResultV3

言語の検出 (V3.1) (プレビュー)

操作 ID:
LanguagesV3_1

API は、検出された言語と 0 から 1 までの数値スコアを返します。 1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。 サポートする言語の一覧については、言語検出にご利用いただける言語を参照してください。

パラメーター

名前 キー 必須 型 説明
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string
countryHint
 countryHint string

戻り値

本文​​
LanguageResult

言語の検出 (V4) (プレビュー)

操作 ID:
LanguagesV4

API は、検出された言語と 0 から 1 までの数値スコアを返します。 1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。 サポートする言語の一覧については、言語検出にご利用いただける言語を参照してください。

パラメーター

名前 キー 必須 型 説明
リソースのサブドメインや地域
 subdomain True string

Azure のサブドメインまたは地理的地域 (例: westus)
モデル バージョン
 model-version string

(オプション) この値は、スコアリングに使用されるモデルを示します。 モデルバージョンが指定されていない場合、API は既定で最新のプレビュー版以外のバージョンになります。
showStats
 showStats boolean

(オプション) true に設定すると、要求とドキュメント レベルの統計を応答に含めます。
loggingOptOut
 loggingOptOut boolean

(オプション) true に設定すると、トラブルシューティング用に行うテキスト入力のログ記録をオプトアウトします。 デフォルトでは、Azure Cognitive Service for Language は入力テキストを 48 時間記録しますが、これは Azure Cognitive Service for Language の自然言語処理機能を提供する際のトラブルシューティングの目的にのみ行われます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修正する機能が制限される可能性があります。 詳細については、Cognitive Services のコンプライアンスとプライバシーに関する注意事項を https://aka.ms/cs-compliance から、Microsoft の責任ある AI の原則を https://www.microsoft.com/en-us/ai/responsible-ai からご覧ください。
id
 id True string

空ではない一意のドキュメント識別子です。
テキスト
 text True string
countryHint
 countryHint string

戻り値

本文​​
LanguageResult

言語の検出 [非推奨]

操作 ID:
DetectLanguage

このアクションは非推奨になりました。 代わりに言語の検出 (V4) を使用してください。

検出された言語と 0 から 1 の数値スコアを返します。1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。合計 120 の言語がサポートされています。

パラメーター

名前 キー 必須 型 説明
テキスト
 text string

分析対象テキストです。
言語の数
 numberOfLanguagesToDetect integer

検出する言語の数です。 既定で 1 に設定します。

戻り値

本文​​
LanguageResult

言語の検出 [非推奨]

操作 ID:
DetectLanguageV2

このアクションは非推奨になりました。 代わりに言語の検出 (V4) を使用してください。

検出された言語と 0 から 1 の数値スコアを返します。1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。合計 120 の言語がサポートされています。

パラメーター

名前 キー 必須 型 説明
テキスト
 text string

分析対象テキストです。

戻り値

本文​​
LanguageResult

定義

DocumentError

名前 パス 型 説明
ID
 id string

ドキュメント ID です。
エラー
 error TextAnalyticsError

TextAnalyticsError

名前 パス 型 説明
コード
 code string

エラー コードです。
メッセージ
 message string

エラー メッセージ。
対象
 target string

エラー ターゲットです。
innererror
 innererror InnerError
詳細
 details array of TextAnalyticsError

この報告されたエラーに関する詳細です。

TextAnalyticsWarning

名前 パス 型 説明
コード
 code string

エラー コードです。
メッセージ
 message string

警告メッセージです。
targetRef
 targetRef string

ターゲット オブジェクトを示す JSON ポインターの参照です。

InnerError

名前 パス 型 説明
コード
 code string

エラー コードです。
メッセージ
 message string

エラー メッセージ。
詳細
 details object

エラーの詳細です。
対象
 target string

エラー ターゲットです。
innererror
 innererror InnerError

SentimentResponse

名前 パス 型 説明
ドキュメント
 documents array of DocumentSentiment

ドキュメントごとの感情分析です。
エラー
 errors array of DocumentError

ドキュメント ID 別のエラーです。
統計
 statistics RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求のペイロードに関する情報が含まれます。
modelVersion
 modelVersion string

このフィールドは、スコアリングに使用されるモデルを示します。

DocumentSentiment

名前 パス 型 説明
ID
 id string

空ではない一意のドキュメント識別子です。
センチメント
 sentiment string

ドキュメントに対して予測されるセンチメント (否定的、中立的、肯定的、または混合) です。
統計
 statistics DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメントのペイロードに関する情報が含まれます。
confidenceScores
 confidenceScores SentimentConfidenceScorePerLabel

すべてのセンチメント クラスを通して 0 から 1 の間の値で設定される信頼度スコア (肯定的、中立的、否定的) を表します。
文
 sentences array of SentenceSentiment

文レベルの感情分析です。
警告
 warnings array of TextAnalyticsWarning

ドキュメントの処理中に警告が発生しました。

RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求のペイロードに関する情報が含まれます。

名前 パス 型 説明
documentsCount
 documentsCount integer

要求で送信されたドキュメントの数です。
validDocumentsCount
 validDocumentsCount integer

有効なドキュメントの数です。 これには、空のものや、サイズ制限を超えるもの、または言語がサポート対象外のものは含まれません。
erroneousDocumentsCount
 erroneousDocumentsCount integer

無効なドキュメントの数です。 これには、空のものや、サイズ制限を超えるもの、または言語がサポート対象外のものが含まれます。
transactionsCount
 transactionsCount integer

要求のトランザクションの数です。

DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメントのペイロードに関する情報が含まれます。

名前 パス 型 説明
charactersCount
 charactersCount integer

ドキュメントで認識されるテキスト要素の数です。
transactionsCount
 transactionsCount integer

ドキュメントのトランザクションの数です。

SentimentConfidenceScorePerLabel

すべてのセンチメント クラスを通して 0 から 1 の間の値で設定される信頼度スコア (肯定的、中立的、否定的) を表します。

名前 パス 型 説明
肯定的
 positive double
中立的
 neutral double
否定的
 negative double

SentenceSentiment

名前 パス 型 説明
テキスト
 text string

文のテキストです。
センチメント
 sentiment string

文に対して予測されたセンチメントです。
confidenceScores
 confidenceScores SentimentConfidenceScorePerLabel

すべてのセンチメント クラスを通して 0 から 1 の間の値で設定される信頼度スコア (肯定的、中立的、否定的) を表します。
オフセット
 offset integer

ドキュメントの開始からの文オフセットです。
長さ
 length integer

Unicode 標準による文の長さです。

DocumentEntities

名前 パス 型 説明
ID
 id string

空ではない一意のドキュメント識別子です。
entities
 entities array of Entity

ドキュメント内で認識されたエンティティです。
警告
 warnings array of TextAnalyticsWarning

ドキュメントの処理中に警告が発生しました。
統計
 statistics DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメントのペイロードに関する情報が含まれます。

PiiDocumentEntities

名前 パス 型 説明
id
 id string

空ではない一意のドキュメント識別子です。
redactedText
 redactedText string

編集済みのテキストを返します。
entities
 entities array of Entity

ドキュメント内で認識されたエンティティです。
警告
 warnings array of TextAnalyticsWarning

ドキュメントの処理中に警告が発生しました。
統計
 statistics DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメントのペイロードに関する情報が含まれます。

Entity

名前 パス 型 説明
テキスト
 text string

要求に表示されるエンティティ テキストです。
カテゴリ
 category string

エンティティの種類 (ユーザー、場所、組織、SSN など)
subcategory
 subcategory string

エンティティのサブ タイプ (年齢、年、時間範囲など)
オフセット
 offset integer

エンティティ テキスト (Unicode 文字) の開始位置です。
長さ
 length integer

エンティティ テキスト (Unicode 文字) の長さです。
confidenceScore
 confidenceScore double

抽出されたエンティティの、0 から 1 の値で設定される信頼度スコアです。

EntityLinkingResult

名前 パス 型 説明
ドキュメント
 documents array of DocumentLinkedEntities

ドキュメント別の応答
エラー
 errors array of DocumentError

ドキュメント ID 別のエラーです。
統計
 statistics RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求のペイロードに関する情報が含まれます。
modelVersion
 modelVersion string

このフィールドは、スコアリングに使用されるモデルを示します。

DocumentLinkedEntities

名前 パス 型 説明
ID
 id string

空ではない一意のドキュメント識別子です。
entities
 entities array of LinkedEntity

ドキュメント内で認識された既知のエンティティです。
警告
 warnings array of TextAnalyticsWarning

ドキュメントの処理中に警告が発生しました。
統計
 statistics DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメントのペイロードに関する情報が含まれます。

LinkedEntity

名前 パス 型 説明
名前
 name string

正式な名前をリンクしているエンティティです。
一致
 matches array of Match

このエンティティがテキストに表示されるインスタンスの一覧です。
言語
 language string

データ ソースで使用される言語です。
ID
 id string

データ ソースから認識されたエンティティを表す一意識別子です。
url
 url string

データ ソースからのエンティティのページの URL です。
dataSource
 dataSource string

エンティティのリンクを抽出するために使用されるデータ ソースです (Wiki、Bing など)。

照合

名前 パス 型 説明
confidenceScore
 confidenceScore double

既知の項目が認識されると、信頼レベルを示す 10 進数 (0 から 1 の間の値) が返されます。
テキスト
 text string

要求に表示されるエンティティ テキストです。
オフセット
 offset integer

エンティティ一致テキスト (Unicode 文字) の開始位置です。
長さ
 length integer

エンティティ一致テキスト (Unicode 文字) の長さです。

DocumentKeyPhrases

名前 パス 型 説明
ID
 id string

空ではない一意のドキュメント識別子です。
KeyPhrase
 keyPhrases array of string

代表的な単語やフレーズの一覧です。 返されるキー フレーズの数は、入力ドキュメント内の単語数に比例します。
警告
 warnings array of TextAnalyticsWarning

ドキュメントの処理中に警告が発生しました。
統計
 statistics DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメントのペイロードに関する情報が含まれます。

DocumentLanguage

名前 パス 型 説明
ID
 id string

空ではない一意のドキュメント識別子です。
detectedLanguage
 detectedLanguage DetectedLanguage
警告
 warnings array of TextAnalyticsWarning

ドキュメントの処理中に警告が発生しました。
統計
 statistics DocumentStatistics

要求で showStats=true が指定された場合、このフィールドにはドキュメントのペイロードに関する情報が含まれます。

DetectedLanguage

名前 パス 型 説明
名前
 name string

検出された言語の長い名前 (例: 英語、フランス語)。
iso6391Name
 iso6391Name string

検出された言語を ISO 639-1 標準に従って 2 文字で表したもの (例: en、fr)。
confidenceScore
 confidenceScore double

0 から 1 の間の信頼度スコアです。 1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。

KeyPhraseResultV3

名前 パス 型 説明
ドキュメント
 documents array of DocumentKeyPhrases

ドキュメント別の応答
エラー
 errors array of DocumentError

ドキュメント ID 別のエラーです。
統計
 statistics RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求のペイロードに関する情報が含まれます。
modelVersion
 modelVersion string

このフィールドは、スコアリングに使用されるモデルを示します。

EntitiesResultV3

名前 パス 型 説明
ドキュメント
 documents array of DocumentEntities

ドキュメント別の応答
エラー
 errors array of DocumentError

ドキュメント ID 別のエラーです。
統計
 statistics RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求のペイロードに関する情報が含まれます。
modelVersion
 modelVersion string

このフィールドは、スコアリングに使用されるモデルを示します。

PiiResult

名前 パス 型 説明
ドキュメント
 documents array of PiiDocumentEntities

ドキュメント別の応答
errors
 errors array of DocumentError

ドキュメント ID 別のエラーです。
統計
 statistics RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求のペイロードに関する情報が含まれます。
modelVersion
 modelVersion string

このフィールドは、スコアリングに使用されるモデルを示します。

LanguageResultV3

名前 パス 型 説明
ドキュメント
 documents array of DocumentLanguage

ドキュメント別の応答
エラー
 errors array of DocumentError

ドキュメント ID 別のエラーです。
統計
 statistics RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求のペイロードに関する情報が含まれます。
modelVersion
 modelVersion string

このフィールドは、スコアリングに使用されるモデルを示します。

KeyPhraseResults

名前 パス 型 説明
ドキュメント
 documents array of KeyPhraseResult

EntitiesResults

名前 パス 型 説明
ドキュメント
 documents array of EntitiesResult

LanguageResults

名前 パス 型 説明
ドキュメント
 documents array of LanguageResult

SentimentResults

名前 パス 型 説明
ドキュメント
 documents array of SentimentResult

KeyPhraseResult

名前 パス 型 説明
キー フレーズ
 keyPhrases array of string

代表的な単語やフレーズの一覧です。 返されるキー フレーズの数は、入力ドキュメント内の単語数に比例します。
ID
 id string

一意のドキュメント識別子です。

EntitiesResult

名前 パス 型 説明
エンティティ
 entities array of object

Web の詳細情報へのリンクを含む曖昧さ回避されたエンティティの一覧です (Wikipedia および Bing)。
件名
 entities.name string

エンティティの名前。
一致
 entities.matches array of object

エンティティの一致項目一覧です。
項目
 entities.matches object
Wikipedia 言語
 entities.wikipediaLanguage string

エンティティの Wikipedia 言語です。
Wikipedia ID
 entities.wikipediaId string

エンティティの Wikipedia ID です。
Wikipedia URL
 entities.wikipediaUrl string

エンティティの Wikipedia URL です。
Bing ID
 entities.bingId string

エンティティの Bing ID です。
タイプ
 entities.type string

エンティティのタイプです。
サブタイプ
 entities.subType string

エンティティのサブタイプです。
ID
 id string

一意のドキュメント識別子です。

LanguageResult

名前 パス 型 説明
ID
 id string

一意のドキュメント識別子です。
detectedLanguages
 detectedLanguages array of DetectedLanguageV2

抽出された言語の一覧です。

SentimentResult

名前 パス 型 説明
スコア
 score double

ドキュメントのセンチメントを示す 0 から 1 までの 10 進数です。 通常、0.7 を超えるスコアは肯定的ドキュメントを指し、0.3 を下回るスコアは通常否定的な意味合いを持ちます。 中間値は中立的なテキストを指します。
ID
 id string

一意のドキュメント識別子です。

DetectedLanguageV2

名前 パス 型 説明
件名
 name string

検出された言語の詳しい名前 (例: 英語、フランス語)。
言語コード
 iso6391Name string

検出された言語を ISO 639-1 標準に従って 2 文字で表したもの (例: en、fr)。
スコア
 score double

0 から 1 の間の信頼度スコアです。 1 に近いスコアは、識別された言語が当てはまることが 100% 確実であることを示します。