Azure Cognitive Service for Language

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

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

サービス クラス リージョン
Logic Apps 標準 すべての Logic Apps 地域
Power Automate 標準 すべての Power Automate 地域
Power Apps - 該当なし
お問い合わせ先
件名 マイクロソフト
[URL] https://gallery.cortanaanalytics.com/MachineLearningAPI/Text-Analytics-2
メール mlapi@microsoft.com
Connector Metadata
発行者 マイクロソフト
Web サイト https://azure.microsoft.com/services/cognitive-services/text-analytics/

注意

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

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

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

Microsoft Entra ID との接続

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

Microsoft Entra ID 認証でサポートされていない操作

Microsoft Entra ID 認証を使用する場合、V4 アクションのみがサポートされています。 非推奨アクションは引き続き Access Key 認証で機能しますが、Microsoft Entra 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 呼び出し 1200 60 秒

アクション

エンティティ [非推奨]

このアクションは非推奨になりました。 代わりに名前付きエンティティの認識 (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 に近いスコアは否定的センチメントを示します。

プロジェクトから回答を生成する

このアクションは、プロジェクトのナレッジベースを使用して指定された質問に回答するのに役立ちます。

会話 (CLU) (2022-05-01)

入力された会話の発話を分析します。

会話 (オーケストレーション) (2022-05-01)

入力された会話の発話を分析します。

個人情報の検出 (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 の言語がサポートされています。

非同期 AbstractiveSummarization (2022-10-01-preview)

抽象要約処理用にテキスト ドキュメントのコレクションを送信する

非同期 CustomEntityRecognition (2022-05-01)

ユーザー定義エンティティの認識を分析するために、テキスト ドキュメントのコレクションを送信します。

非同期 CustomMultiLabelClassification (2022-05-01)

ユーザー定義の 1 つの分類を分析するために、テキスト ドキュメントのコレクションを送信します。

非同期 CustomSingleLabelClassification (2022-05-01)

ユーザー定義の 1 つの分類を分析するために、テキスト ドキュメントのコレクションを送信します。

非同期 EntityLinking (2022-05-01)

エンティティのリンク作成を分析するために、テキスト ドキュメントのコレクションを送信します。

非同期 EntityRecognition (2022-05-01)

エンティティの認識を分析するために、テキスト ドキュメントのコレクションを送信します。

非同期 ExtractiveSummarization (2022-10-01-preview)

抽出要約処理用にテキスト ドキュメントのコレクションを送信する

非同期 Healthcare (2022-05-01)

医療を分析するために、テキスト ドキュメントのコレクションを送信します。

非同期 KeyPhrases (2022-05-01)

キー フレーズの抽出を分析するために、テキスト ドキュメントのコレクションを送信します。

非同期 PiiEntityRecognition (2022-05-01)

個人的なエンティティの認識を分析するために、テキスト ドキュメントのコレクションを送信します。

非同期 SentimentAnalysis (2022-05-01)

センチメントを分析するために、テキスト ドキュメントのコレクションを送信します。

非同期会話 PII (テキスト) (2022-05-15-プレビュー)

分析のために会話のコレクションを送信します。 実行する 1 つ以上の固有のタスクを指定します。

非同期会話 PII (トランスクリプト) (2022-05-15-プレビュー)

分析のために会話のコレクションを送信します。 実行する 1 つ以上の固有のタスクを指定します。

非同期会話の要約処理 (2022-05-15-プレビュー)

分析のために会話のコレクションを送信します。 実行する 1 つ以上の固有のタスクを指定します。

エンティティ [非推奨]

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

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

パラメーター

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

分析対象テキストです。

言語
language string

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

戻り値

本文​​
EntitiesResult

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

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) (プレビュー)

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) (プレビュー)

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) [非推奨]

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

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

パラメーター

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

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

テキスト
text True string

分析対象テキストです。

言語
language string

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

戻り値

本文​​
EntitiesResults

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

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

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

パラメーター

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

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

テキスト
text True string

分析対象テキストです。

言語
language string

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

戻り値

本文​​
KeyPhraseResults

キー フレーズ (V3.0)

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) (プレビュー)

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) (プレビュー)

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

キー フレーズ [非推奨]

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

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

パラメーター

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

分析対象テキストです。

言語
language string

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

戻り値

本文​​
KeyPhraseResult

キー フレーズ [非推奨]

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

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

パラメーター

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

分析対象テキストです。

言語
language string

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

戻り値

本文​​
KeyPhraseResult

センチメント (V3.0)

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) (プレビュー)

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」 を使用します。

戻り値

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

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」 を使用します。

戻り値

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

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

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

パラメーター

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

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

テキスト
text True string

分析対象テキストです。

言語
language string

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

戻り値

本文​​
SentimentResults

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

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

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

パラメーター

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

分析対象テキストです。

言語
language string

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

戻り値

本文​​
SentimentResult

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

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

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

パラメーター

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

分析対象テキストです。

言語
language string

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

戻り値

本文​​
SentimentResult

プロジェクトから回答を生成する

このアクションは、プロジェクトのナレッジベースを使用して指定された質問に回答するのに役立ちます。

パラメーター

名前 キー 必須 説明
プロジェクト名
projectName True string

これは使用したいプロジェクト名です。

質問
question string

プロジェクトに対してクエリするユーザーの質問。

ユーザー ID
userId string

ユーザーを表す一意の識別子です。

上位 #
top integer

質問に対して返される回答の最大数

Confidence Threshold
confidenceScoreThreshold float

回答の最小しきい値スコア。 値の範囲は 0 から 1 です。

ランカーの種類
rankerType string

使用されるランカーの種類。

QnA ID
qnaId string

これは、プロジェクトからフェッチする正確な QnA ID です。

以前の QnA ID
previousQnaId integer

以前の上位回答結果 QnA ID。

以前のユーザー クエリ
previousUserQuery string

以前のユーザー クエリ。

key
key string

QnA で使用されるメタデータ辞書のメタデータキー。

value string

QnA で使用されるメタデータ辞書からのメタデータ値。

Join Metadata with
logicalOperation string

メタデータ フィルターの対応する論理演算には、'OR' または 'AND' を設定します。

ソース フィルター
sourceFilter string

プロジェクト内の指定されたソースのリストのいずれかに関連付けられている QnA を検索します。

Join Filters with
logicalOperation string

メタデータ フィルターをソース フィルターと結合するために使用される論理演算。

Enable precise answer
enable boolean

Answer Span 予測を有効または無効にします。

Confidence Threshold
confidenceScoreThreshold float

正確な回答を含めるために必要な最小しきい値スコア。値の範囲は 0〜1 です。

上位 #
topAnswersWithSpan integer

正確な回答予測の 1 から 10 までの上位回答の数。

Include Unstructured Sources
includeUnstructuredSources boolean

非構造化ソースに対するクエリを有効にするフラグ。

Deployment Name
deploymentName True string

これは、使用するプロジェクトの特定の展開です。

API Version
api-version True string

これは、クライアント API バージョンです。

戻り値

質問回答のリストを表します。

会話 (CLU) (2022-05-01)

入力された会話の発話を分析します。

パラメーター

名前 キー 必須 説明
language
language string

会話項目の上書き言語 (BCP 47 言語表現) です。

text
text True string

テキスト入力

projectName
projectName True string

使用するプロジェクトの名前。

deploymentName
deploymentName True string

使用する展開の名前です。

verbose
verbose boolean

true の場合、サービスは詳細情報を応答に含めて返します。

戻り値

会話タスクの結果です。

会話 (オーケストレーション) (2022-05-01)

入力された会話の発話を分析します。

パラメーター

名前 キー 必須 説明
language
language string

会話項目の上書き言語 (BCP 47 言語表現) です。

text
text True string

テキスト入力

projectName
projectName True string

使用するプロジェクトの名前。

deploymentName
deploymentName True string

使用する展開の名前です。

verbose
verbose boolean

true の場合、サービスは詳細情報を応答に含めて返します。

directTarget
directTarget string

要求の転送先プロジェクトの名前です。

targetProjectParameters
targetProjectParameters object

各ターゲット プロジェクトのパラメーターを表す辞書です。

戻り値

会話タスクの結果です。

個人情報の検出 (V3.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) (プレビュー)

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」 を使用します。

戻り値

Body
PiiResult

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

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) (プレビュー)

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) (プレビュー)

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) [非推奨]

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

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

パラメーター

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

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

テキスト
text True string

分析対象テキストです。

戻り値

本文​​
LanguageResults

言語の検出 (V3.0)

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) (プレビュー)

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) (プレビュー)

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

言語の検出 [非推奨]

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

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

パラメーター

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

分析対象テキストです。

言語の数
numberOfLanguagesToDetect integer

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

戻り値

本文​​
LanguageResult

言語の検出 [非推奨]

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

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

パラメーター

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

分析対象テキストです。

戻り値

本文​​
LanguageResult

非同期 AbstractiveSummarization (2022-10-01-preview)

抽象要約処理用にテキスト ドキュメントのコレクションを送信する

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

sentenceCount
sentenceCount integer

出力要約に含まれる文の概数を制御します。

戻り値

非同期 CustomEntityRecognition (2022-05-01)

ユーザー定義エンティティの認識を分析するために、テキスト ドキュメントのコレクションを送信します。

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

projectName
projectName True string

このフィールドはモデルのプロジェクト名を示します。

deploymentName
deploymentName True string

このフィールドはモデルの展開名を示します。

戻り値

非同期 CustomMultiLabelClassification (2022-05-01)

ユーザー定義の 1 つの分類を分析するために、テキスト ドキュメントのコレクションを送信します。

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

projectName
projectName True string

このフィールドはモデルのプロジェクト名を示します。

deploymentName
deploymentName True string

このフィールドはモデルの展開名を示します。

戻り値

非同期 CustomSingleLabelClassification (2022-05-01)

ユーザー定義の 1 つの分類を分析するために、テキスト ドキュメントのコレクションを送信します。

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

projectName
projectName True string

このフィールドはモデルのプロジェクト名を示します。

deploymentName
deploymentName True string

このフィールドはモデルの展開名を示します。

戻り値

非同期 EntityLinking (2022-05-01)

エンティティのリンク作成を分析するために、テキスト ドキュメントのコレクションを送信します。

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

戻り値

非同期 EntityRecognition (2022-05-01)

エンティティの認識を分析するために、テキスト ドキュメントのコレクションを送信します。

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

戻り値

非同期 ExtractiveSummarization (2022-10-01-preview)

抽出要約処理用にテキスト ドキュメントのコレクションを送信する

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

sentenceCount
sentenceCount integer
sortBy
sortBy string

抽出要約処理の結果に使用する並べ替え条件です。

戻り値

非同期 Healthcare (2022-05-01)

医療を分析するために、テキスト ドキュメントのコレクションを送信します。

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

戻り値

非同期 KeyPhrases (2022-05-01)

キー フレーズの抽出を分析するために、テキスト ドキュメントのコレクションを送信します。

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

loggingOptOut
loggingOptOut boolean

戻り値

非同期 PiiEntityRecognition (2022-05-01)

個人的なエンティティの認識を分析するために、テキスト ドキュメントのコレクションを送信します。

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

ドメイン
domain string

PII エンティティ認識に使用する PII ドメイン。

piiCategories
piiCategories array of string

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

戻り値

非同期 SentimentAnalysis (2022-05-01)

センチメントを分析するために、テキスト ドキュメントのコレクションを送信します。

パラメーター

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

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

text
text True string

処理する入力テキストです。

言語
language string

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

opinionMining
opinionMining boolean

戻り値

非同期会話 PII (テキスト) (2022-05-15-プレビュー)

分析のために会話のコレクションを送信します。 実行する 1 つ以上の固有のタスクを指定します。

パラメーター

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

会話項目の ID です。

participantId
participantId True string

会話項目の参加者 ID です。

language
language string

会話項目の上書き言語 (BCP 47 言語表現) です。

role
role string

参加者のロール。

text
text True string

テキスト入力

language
language True string

BCP-47 形式で表した会話項目の言語。

ドメイン
domain string

サポートされている会話ドメインの列挙です。

loggingOptOut
loggingOptOut boolean
piiCategories
piiCategories array of string

返す PII カテゴリについて説明します。 指定しない場合、言語によって異なる 'デフォルト' のカテゴリが返されます。

戻り値

送信済みの会話分析ジョブの状態と、関連する統計を含みます。

非同期会話 PII (トランスクリプト) (2022-05-15-プレビュー)

分析のために会話のコレクションを送信します。 実行する 1 つ以上の固有のタスクを指定します。

パラメーター

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

会話項目の ID です。

participantId
participantId True string

会話項目の参加者 ID です。

language
language string

会話項目の上書き言語 (BCP 47 言語表現) です。

role
role string

参加者のロール。

itn
itn string

入力の逆テキスト正規化表現。 逆テキスト正規化フォームは、Microsoft の Speech to Text API から認識されるテキストであり、電話番号、番号、略称、その他の変換が当てはまります。

maskedItn
maskedItn string

不適切にマスキングされた逆テキスト正規化形式です。

text
text string

Speech to Text API から認識されたテキストの表示形式です。句読点が追加され、大文字化が行われています。

lexical
lexical string

Speech to Text API から認識されたテキストの語彙形式です。実際の単語が認識されています。

word
word string

認識された単語です。

offset
offset integer

ティック単位で表したスピーチ音声の開始からのオフセット。 1 ティック = 100 ナノ秒。

duration
duration integer

ティック単位で表した単語明瞭度の持続時間。 1 ティック = 100 ナノ秒。

language
language True string

BCP-47 形式で表した会話項目の言語。

ドメイン
domain string

サポートされている会話ドメインの列挙です。

loggingOptOut
loggingOptOut boolean
piiCategories
piiCategories array of string

返す PII カテゴリについて説明します。 指定しない場合、言語によって異なる 'デフォルト' のカテゴリが返されます。

includeAudioRedaction
includeAudioRedaction boolean

オーディオ編集が要求されているかどうかを示すフラグ。 デフォルトでは、オーディオ編集は実行されません。

redactionSource
redactionSource string

サポートされている文字起こしのコンテンツ タイプの列挙です。

戻り値

送信済みの会話分析ジョブの状態と、関連する統計を含みます。

非同期会話の要約処理 (2022-05-15-プレビュー)

分析のために会話のコレクションを送信します。 実行する 1 つ以上の固有のタスクを指定します。

パラメーター

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

会話項目の ID です。

participantId
participantId True string

会話項目の参加者 ID です。

language
language string

会話項目の上書き言語 (BCP 47 言語表現) です。

role
role string

参加者のロール。

text
text True string

テキスト入力

language
language True string

BCP-47 形式で表した会話項目の言語。

ドメイン
domain string

サポートされている会話ドメインの列挙です。

loggingOptOut
loggingOptOut boolean
summaryAspects
summaryAspects True array of string

戻り値

送信済みの会話分析ジョブの状態と、関連する統計を含みます。

定義

ConversationalPIITranscriptJobState

送信済みの会話分析ジョブの状態と、関連する統計を含みます。

名前 パス 説明
displayName
displayName string
createdDateTime
createdDateTime date-time
expirationDateTime
expirationDateTime date-time
jobId
jobId string
lastUpdatedDateTime
lastUpdatedDateTime date-time
ステータス
status string
errors
errors array of Error
nextLink
nextLink string
統計
statistics ConversationRequestStatistics

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

completed
tasks.completed integer

正常に完了したタスクの数。

失敗
tasks.failed integer

失敗したタスクの数。

inProgress
tasks.inProgress integer

現在処理しているタスクの数。

total
tasks.total integer

ジョブの一部として送信したタスクの総数。

taskResult
tasks.taskResult ConversationalPIITranscriptResult

会話のリストに対して実行した、個人を特定できる情報の検出と編集操作の結果。

ConversationRequestStatistics

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

名前 パス 説明
documentsCount
documentsCount integer

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

validDocumentsCount
validDocumentsCount integer

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

erroneousDocumentsCount
erroneousDocumentsCount integer

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

transactionsCount
transactionsCount integer

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

conversationsCount
conversationsCount integer

要求で送信された会話の数です。

validConversationsCount
validConversationsCount integer

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

erroneousConversationsCount
erroneousConversationsCount integer

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

ConversationalPIITranscriptResult

会話のリストに対して実行した、個人を特定できる情報の検出と編集操作の結果。

名前 パス 説明
lastUpdateDateTime
lastUpdateDateTime date-time

タスクを最後に更新した UTC 時刻。

ステータス
status

言及した最終更新時刻におけるタスクの状態。

taskName
taskName string
kind
kind ConversationalPIIResultsKind

サポートしている会話分析タスクの結果の列挙。

results
results ConversationPIITranscriptResults

各会話に対する PII 検出と編集操作の結果。

ConversationalPIIResultsKind

サポートしている会話分析タスクの結果の列挙。

ConversationPIITranscriptResults

各会話に対する PII 検出と編集操作の結果。

名前 パス 説明
conversationItems
conversations.conversationItems array of ConversationPIITranscriptItemResult

会話が含むすべての会話項目に対する、PII 検出と編集操作の結果を含む列挙。

id
conversations.id string

空白ではない一意の会話の識別子。

warnings
conversations.warnings array of InputWarning

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

統計
conversations.statistics ConversationStatistics

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

errors
errors array of InputError

ドキュメント ID 別のエラーです。

統計
statistics RequestStatistics

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

modelVersion
modelVersion string

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

InputError

ジョブ実行中に発生したエラーの詳細を含みます。

名前 パス 説明
id
id string

入力の ID です。

エラー
error Error

エラー オブジェクト。

InputWarning

ジョブ実行中に発生した警告の詳細を含みます。

名前 パス 説明
code
code string

警告コードです。

message
message string

警告メッセージです。

targetRef
targetRef string

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

ConversationStatistics

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

名前 パス 説明
transactionsCount
transactionsCount integer

要求のテキスト単位数です。

ConversationPIITranscriptItemResult

名前 パス 説明
id
id string
redactedContent
redactedContent ConversationalPIITranscriptRedactedTranscriptContent

必要なすべての個人を特定できる情報を編集した、サービスが生成したトランスクリプト コンテンツ応答。

entities
entities array of Entity

ConversationalPIITranscriptRedactedTranscriptContent

必要なすべての個人を特定できる情報を編集した、サービスが生成したトランスクリプト コンテンツ応答。

名前 パス 説明
itn
itn string

逆テキスト正規化形式の入力を編集した出力です。

maskedItn
maskedItn string

マスキングされた逆テキスト正規化形式の入力を編集した出力です。

text
text string

テキスト (Microsoft の音声テキスト変換 '表示') 形式の入力に対する編集した出力。

lexical
lexical string

語彙形式の入力を編集した出力です。

audioTimings
audioTimings array of AudioTiming

編集されたオーディオ セグメントの一覧です。

AudioTiming

オーディオ タイミング情報です。

名前 パス 説明
offset
offset integer

ティック単位で表したスピーチ音声の開始からのオフセット。 1 ティック = 100 ナノ秒。

duration
duration integer

ティック単位で表した単語明瞭度の持続時間。 1 ティック = 100 ナノ秒。

ConversationalPIITextJobState

送信済みの会話分析ジョブの状態と、関連する統計を含みます。

名前 パス 説明
displayName
displayName string
createdDateTime
createdDateTime date-time
expirationDateTime
expirationDateTime date-time
jobId
jobId string
lastUpdatedDateTime
lastUpdatedDateTime date-time
ステータス
status string
errors
errors array of Error
nextLink
nextLink string
統計
statistics ConversationRequestStatistics

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

completed
tasks.completed integer

正常に完了したタスクの数。

失敗
tasks.failed integer

失敗したタスクの数。

inProgress
tasks.inProgress integer

現在処理しているタスクの数。

total
tasks.total integer

ジョブの一部として送信したタスクの総数。

taskResult
tasks.taskResult ConversationalPIITextResult

会話のリストに対して実行した、個人を特定できる情報の検出と編集操作の結果。

ConversationalPIITextResult

会話のリストに対して実行した、個人を特定できる情報の検出と編集操作の結果。

名前 パス 説明
lastUpdateDateTime
lastUpdateDateTime date-time

タスクを最後に更新した UTC 時刻。

ステータス
status

言及した最終更新時刻におけるタスクの状態。

taskName
taskName string
kind
kind ConversationalPIIResultsKind

サポートしている会話分析タスクの結果の列挙。

results
results ConversationPIITextResults

各会話に対する PII 検出と編集操作の結果。

ConversationPIITextResults

各会話に対する PII 検出と編集操作の結果。

名前 パス 説明
conversationItems
conversations.conversationItems array of ConversationPIITextItemResult

会話が含むすべての会話項目に対する、PII 検出と編集操作の結果を含む列挙。

id
conversations.id string

空白ではない一意の会話の識別子。

warnings
conversations.warnings array of InputWarning

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

統計
conversations.statistics ConversationStatistics

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

errors
errors array of InputError

ドキュメント ID 別のエラーです。

統計
statistics RequestStatistics

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

modelVersion
modelVersion string

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

ConversationPIITextItemResult

名前 パス 説明
id
id string
redactedContent
redactedContent ConversationalPIITranscriptRedactedTextContent

必要なすべての個人を特定できる情報を編集した、サービスが生成したトランスクリプト コンテンツ応答。

entities
entities array of Entity

ConversationalPIITranscriptRedactedTextContent

必要なすべての個人を特定できる情報を編集した、サービスが生成したトランスクリプト コンテンツ応答。

名前 パス 説明
text
text string

テキスト (Microsoft の音声テキスト変換 '表示') 形式の入力に対する編集した出力。

AnalyzeConversationSummarizationJobState

送信済みの会話分析ジョブの状態と、関連する統計を含みます。

名前 パス 説明
displayName
displayName string
createdDateTime
createdDateTime date-time
expirationDateTime
expirationDateTime date-time
jobId
jobId string
lastUpdatedDateTime
lastUpdatedDateTime date-time
ステータス
status string
errors
errors array of Error
nextLink
nextLink string
統計
statistics ConversationRequestStatistics

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

completed
tasks.completed integer

正常に完了したタスクの数。

失敗
tasks.failed integer

失敗したタスクの数。

inProgress
tasks.inProgress integer

現在処理しているタスクの数。

total
tasks.total integer

ジョブの一部として送信したタスクの総数。

taskResult
tasks.taskResult AnalyzeConversationSummarizationResult

会話の要約処理タスクの結果です。

AnalyzeConversationSummarizationResult

会話の要約処理タスクの結果です。

名前 パス 説明
lastUpdateDateTime
lastUpdateDateTime date-time

タスクを最後に更新した UTC 時刻。

ステータス
status

言及した最終更新時刻におけるタスクの状態。

taskName
taskName string
kind
kind ConversationalSummarizationResultsKind

サポートしている会話分析タスクの結果の列挙。

results
results SummaryResult

ConversationalSummarizationResultsKind

サポートしている会話分析タスクの結果の列挙。

SummaryResult

名前 パス 説明
summaries
conversations.summaries array of SummaryResultItem
id
conversations.id string

空白ではない一意の会話の識別子。

warnings
conversations.warnings array of InputWarning

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

統計
conversations.statistics ConversationStatistics

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

errors
errors array of InputError

ドキュメント ID 別のエラーです。

統計
statistics RequestStatistics

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

modelVersion
modelVersion string

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

SummaryResultItem

名前 パス 説明
aspect
aspect string
text
text string

Error

エラー オブジェクト。

名前 パス 説明
code
code ErrorCode

人間が理解できるエラー コード。

message
message string

人による読み取りが可能なエラーの表現です。

ターゲット
target string

エラーの対象。

details
details array of Error

この報告されたエラーの原因となる特定のエラーに関する詳細の配列です。

innererror
innererror InnerErrorModel

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API ガイドライン - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

エラーコード

人間が理解できるエラー コード。

人間が理解できるエラー コード。

InnerErrorModel

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API ガイドライン - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名前 パス 説明
code
code InnerErrorCode

人間が理解できるエラー コード。

message
message string

エラー メッセージ。

details
details object

エラーの詳細。

ターゲット
target string

エラー ターゲットです。

innererror
innererror InnerErrorModel

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API ガイドライン - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

InnerErrorCode

人間が理解できるエラー コード。

人間が理解できるエラー コード。

LanguageCustomEntitiesResult

名前 パス 説明
documents
documents array of LanguageEntitiesDocumentResult

ドキュメント別の応答

LanguageCustomLabelClassificationResult

名前 パス 説明
documents
documents array of LanguageClassificationDocumentResult

ドキュメント別の応答

LanguageClassificationResult

名前 パス 説明
category
category string

分類の種類。

confidenceScore
confidenceScore double

認識されたクラスの信頼度スコア (0 ~ 1) です。

LanguageClassificationDocumentResult

名前 パス 説明
クラス
class array of LanguageClassificationResult
id
id string

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

LanguageHealthcareResult

名前 パス 説明
documents
documents array of LanguageHealthcareEntitiesDocumentResult

LanguageHealthcareEntitiesDocumentResult

名前 パス 説明
entities
entities array of LanguageHealthcareEntity

医療エンティティです。

relations
relations array of LanguageHealthcareRelation

医療エンティティの関係です。

id
id string

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

LanguageHealthcareEntity

名前 パス 説明
text
text string

要求に表示されるエンティティ テキストです。

category
category string

医療エンティティ カテゴリです。

subcategory
subcategory string

(オプション) エンティティのサブ タイプ。

offset
offset integer

エンティティ テキストの開始位置。 異なる 'stringIndexType' 値を使用すると、返されるオフセットに影響を与える可能性があります。

length
length integer

エンティティ テキストの長さ。 異なる 'stringIndexType' 値を使用すると、返される長さに影響を与える可能性があります。

confidenceScore
confidenceScore double

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

assertion
assertion LanguageHealthcareAssertion
名称
name string

エンティティの優先される名前。 例: 'histologically' は 'histologic' の 'name' を持つことになります。

links
links array of LanguageHealthcareEntityLink

既知のデータ ソース内のエンティティ参照です。

LanguageHealthcareRelation

関係はすべて、特定の relationType のエンティティ グラフであり、すべてのエンティティが接続されて、関係コンテキスト内で特定のロールが与えられます。

名前 パス 説明
relationType
relationType string

関係の種類。 例: DosageOfMedication や 'FrequencyOfMedication' など。

entities
entities array of LanguageHealthcareRelationEntity

関係が含むエンティティ。

LanguageHealthcareAssertion

名前 パス 説明
conditionality
conditionality string

エンティティの条件付けを記述します。

certainty
certainty string

エンティティの確実性と両極性を記述します。

関連
association string

エンティティがテキストの件名か、それとも他のユーザーを表すのかを示します。

LanguageHealthcareRelationEntity

名前 パス 説明
ref
ref string

JSON ポインター RFC 6901 (URI フラグメント識別子表現) を使用してエンティティをポイントする、参照リンク オブジェクトです。

role
role string

リレーションシップにおけるエンティティのロール。 例: 'CD20-陽性 びまん性大細胞型 B 細胞リンパ腫' には次のエンティティが含まれ、それぞれに括弧内のロールが付与されます: CD20 (遺伝子またはタンパク質)、陽性 (表現)、びまん性大細胞型 B 細胞リンパ腫 (診断)。

名前 パス 説明
dataSource
dataSource string

エンティティ カタログ。 例: UMLS、CHV、MSH など

id
id string

指定されたソース カタログ内のエンティティ ID です。

LanguageSentimentResponse

名前 パス 説明
documents
documents array of LanguageSentimentDocumentResult

ドキュメントごとの感情分析です。

LanguageSentimentDocumentResult

名前 パス 説明
センチメント
sentiment string

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

confidenceScores
confidenceScores LanguageSentimentConfidenceScorePerLabel

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

sentences array of LanguageSentenceSentiment

文レベルの感情分析です。

id
id string

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

LanguageSentimentConfidenceScorePerLabel

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

名前 パス 説明
肯定的
positive double

肯定的なセンチメントの信頼度スコア

中立的
neutral double

中立的な感情分析の信頼度スコア

否定的
negative double

否定的なセンチメントの信頼度スコア

LanguageSentenceSentiment

名前 パス 説明
text
text string

文のテキストです。

センチメント
sentiment string

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

confidenceScores
confidenceScores LanguageSentimentConfidenceScorePerLabel

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

オフセット
offset integer

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

length
length integer

分の長さ。

対象
targets array of LanguageSentenceTarget

文章に対する文章ターゲットを含む配列。

評価
assessments array of LanguageSentenceAssessment

文章の評価を含む配列。

LanguageSentenceTarget

名前 パス 説明
センチメント
sentiment string

文章中のターゲットを絞ったセンチメント。

confidenceScores
confidenceScores LanguageTargetConfidenceScoreLabel

すべてのセンチメント クラスを通して設定される信頼度スコア (肯定的、否定的) を表します。

offset
offset integer

文の開始からのターゲット オフセットです。

length
length integer

ターゲットの長さ。

text
text string

ターゲット テキストを検出しました。

relations
relations array of LanguageTargetRelation

ターゲットに関連する評価やターゲット オブジェクトを含む配列。

LanguageSentenceAssessment

名前 パス 説明
センチメント
sentiment string

文の感情分析に対する評価です。

confidenceScores
confidenceScores LanguageTargetConfidenceScoreLabel

すべてのセンチメント クラスを通して設定される信頼度スコア (肯定的、否定的) を表します。

offset
offset integer

センテンスの開始からの評価オフセットです。

length
length integer

評価の長さ。

text
text string

評価テキストを検出しました。

isNegated
isNegated boolean

評価が否定されるかどうかを表すインジケーター。

LanguageTargetRelation

名前 パス 説明
relationType
relationType string

ターゲットに関連する種類。

ref
ref string

リンクしたオブジェクトを示す JSON ポインター。

LanguageTargetConfidenceScoreLabel

すべてのセンチメント クラスを通して設定される信頼度スコア (肯定的、否定的) を表します。

名前 パス 説明
肯定的
positive double

肯定的なセンチメントの信頼度スコア

否定的
negative double

否定的なセンチメントの信頼度スコア

LanguageEntitiesResult

名前 パス 説明
documents
documents array of LanguageEntitiesDocumentResult

ドキュメント別の応答

LanguageEntitiesDocumentResult

名前 パス 説明
entities
entities array of LanguageEntity

ドキュメント内で認識されたエンティティです。

id
id string

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

LanguageEntity

名前 パス 説明
text
text string

要求に表示されるエンティティ テキストです。

category
category string

エンティティの種類です。

subcategory
subcategory string

(オプション) エンティティのサブ タイプ。

offset
offset integer

エンティティ テキストの開始位置。 異なる 'stringIndexType' 値を使用すると、返されるオフセットに影響を与える可能性があります。

length
length integer

エンティティ テキストの長さ。 異なる 'stringIndexType' 値を使用すると、返される長さに影響を与える可能性があります。

confidenceScore
confidenceScore double

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

LanguageEntityLinkingResult

名前 パス 説明
documents
documents array of LanguageLinkedEntitiesDocumentResult

ドキュメント別の応答

LanguageLinkedEntitiesDocumentResult

名前 パス 説明
entities
entities array of LanguageLinkedEntity

ドキュメント内で認識された既知のエンティティです。

id
id string

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

LanguageLinkedEntity

名前 パス 説明
名称
name string

正式な名前をリンクしているエンティティです。

一致
matches array of LanguageMatch

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

言語
language string

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

ID
id string

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

url
url string

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

dataSource
dataSource string

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

bingId
bingId string

Bing エンティティ検索 API で認識されたエンティティを表す一意識別子です。

LanguageMatch

名前 パス 説明
confidenceScore
confidenceScore double

既知の項目が認識されると、信頼度レベルを示す 10 進数の値 (0 ~ 1) が返されます。

テキスト
text string

要求に表示されるエンティティ テキストです。

offset
offset integer

エンティティ一致テキストの開始位置です。

length
length integer

エンティティ一致テキストの長さです。

LanguagePiiResult

名前 パス 説明
documents
documents array of LanguagePiiEntitiesDocumentResult

ドキュメント別の応答

LanguagePiiEntitiesDocumentResult

名前 パス 説明
redactedText
redactedText string

編集済みのテキストを返します。

entities
entities array of LanguageEntity

ドキュメント内で認識されたエンティティです。

id
id string

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

LanguageKeyPhraseResult

名前 パス 説明
documents
documents array of LanguageKeyPhrasesDocumentResult

ドキュメント別の応答

LanguageKeyPhrasesDocumentResult

名前 パス 説明
KeyPhrase
keyPhrases array of string

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

id
id string

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

LanguageAnalyzeTextJobState_KPE

名前 パス 説明
taskResult
tasks.taskResult LanguageKeyPhraseExtractionLROResult

LanguageAnalyzeTextJobState_CNER

名前 パス 説明
taskResult
tasks.taskResult LanguageCustomEntityRecognitionLROResult

LanguageAnalyzeTextJobState_CSLC

名前 パス 説明
taskResult
tasks.taskResult LanguageCustomSingleLabelClassificationLROResult

LanguageAnalyzeTextJobState_CMLC

名前 パス 説明
taskResult
tasks.taskResult LanguageCustomMultiLabelClassificationLROResult

LanguageAnalyzeTextJobState_Entites

名前 パス 説明
taskResult
tasks.taskResult LanguageEntityRecognitionLROResult

LanguageAnalyzeTextJobState_Pii

名前 パス 説明
taskResult
tasks.taskResult LanguagePiiEntityRecognitionLROResult

LanguageAnalyzeTextJobState_Sentiment

名前 パス 説明
taskResult
tasks.taskResult LanguageSentimentLROResult

LanguageAnalyzeTextJobState_HealthCare

名前 パス 説明
taskResult
tasks.taskResult LanguageHealthcareLROResult

LanguageAnalyzeTextJobState_ExtractiveSummarization

名前 パス 説明
taskResult
tasks.taskResult ExtractiveSummarizationLROResult

LanguageAnalyzeTextJobState_AbstractiveSummarization

名前 パス 説明
taskResult
tasks.taskResult AbstractiveSummarizationLROResult

抽象要約処理の結果を表すオブジェクトです。

LanguageAnalyzeTextJobState_EntityLinking

名前 パス 説明
taskResult
tasks.taskResult LanguageEntityLinkingLROResult

LanguageEntityRecognitionLROResult

名前 パス 説明
results
results LanguageEntitiesResult

LanguageCustomEntityRecognitionLROResult

名前 パス 説明
results
results LanguageCustomEntitiesResult

LanguageCustomSingleLabelClassificationLROResult

名前 パス 説明
results
results LanguageCustomLabelClassificationResult

LanguageCustomMultiLabelClassificationLROResult

名前 パス 説明
results
results LanguageCustomLabelClassificationResult

LanguageEntityLinkingLROResult

名前 パス 説明
results
results LanguageEntityLinkingResult

LanguagePiiEntityRecognitionLROResult

名前 パス 説明
results
results LanguagePiiResult

LanguageHealthcareLROResult

名前 パス 説明
results
results LanguageHealthcareResult

LanguageSentimentLROResult

名前 パス 説明
results
results LanguageSentimentResponse

LanguageKeyPhraseExtractionLROResult

名前 パス 説明
results
results LanguageKeyPhraseResult

LanguageDocumentWarning

名前 パス 説明
code
code string

エラー コードです。

message
message string

警告メッセージです。

targetRef
targetRef string

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

DocumentError

名前 パス 説明
id
id string

ドキュメント ID です。

エラー
error TextAnalyticsError

TextAnalyticsError

名前 パス 説明
code
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% 確実であることを示します。

AnalyzeConversationTaskResultsKind

サポートされている会話タスクの結果の列挙です

サポートされている会話タスクの結果の列挙です

ConversationalTaskResult

会話タスクの結果です。

名前 パス 説明
kind
kind AnalyzeConversationTaskResultsKind

サポートされている会話タスクの結果の列挙です

result
result AnalyzeConversationResult

会話分析の応答を表します。

ConversationalTaskResult_Orchestration

会話タスクの結果です。

名前 パス 説明
kind
kind AnalyzeConversationTaskResultsKind

サポートされている会話タスクの結果の列挙です

result
result AnalyzeConversationResult_Orchestration

会話分析の応答を表します。

AnalyzeConversationResult

会話分析の応答を表します。

名前 パス 説明
query
query string

通話者による会話の発話です。

detectedLanguage
detectedLanguage string

クエリの言語が BCP 47 の言語表現で検出されました..

予測
prediction ConversationPrediction

会話プロジェクトの予測セクションを表します。

AnalyzeConversationResult_Orchestration

会話分析の応答を表します。

名前 パス 説明
query
query string

通話者による会話の発話です。

detectedLanguage
detectedLanguage string

クエリの言語が BCP 47 の言語表現で検出されました..

予測
prediction OrchestrationPrediction

これは、オーケストレーション プロジェクトにおける予測結果を表します。

ConversationPrediction

会話プロジェクトの予測セクションを表します。

名前 パス 説明
intents
intents array of ConversationIntent

意図の分類結果です。

entities
entities array of ConversationEntity

エンティティの抽出結果です。

projectKind
projectKind string

プロジェクトの種類。

topIntent
topIntent string

最高スコアに伴う意図です。

ConversationIntent

会話プロジェクトの意図の分類結果です。

名前 パス 説明
category
category string

予測されたクラスです。

confidenceScore
confidenceScore float

クラスの信頼度スコアです (0.0 ~ 1.0)。

ConversationEntity

会話プロジェクトのエンティティ抽出結果です。

名前 パス 説明
category
category string

エンティティのカテゴリです。

text
text string

予測されたエンティティ テキストです。

offset
offset integer

このクエリ内のエンティティの開始インデックスです。

length
length integer

テキストの長さです。

confidenceScore
confidenceScore float

エンティティの信頼度スコアです。

resolutions
resolutions array of BaseResolution

エンティティ解決オブジェクトのコレクションです。

extraInformation
extraInformation array of BaseExtraInformation

エンティティの追加情報オブジェクトのコレクションです。

topResolution
topResolution BaseResolution

エンティティの解決に必要な抽象基本クラスです。

multipleResolutions
multipleResolutions boolean

解決の配列に複数の項目が含まれているかどうかを示すインジケーターです。

BaseExtraInformation

エンティティの追加情報の抽象基本オブジェクトです。

名前 パス 説明
extraInformationKind
extraInformationKind string

追加情報オブジェクトの種類です。

BaseResolution

エンティティの解決に必要な抽象基本クラスです。

名前 パス 説明
resolutionKind
resolutionKind string

エンティティ解決のオブジェクトの種類です。

OrchestrationPrediction

これは、オーケストレーション プロジェクトにおける予測結果を表します。

名前 パス 説明
intents
intents object

すべてのインテントを含むディクショナリ。 キーはインテント名で、値はその信頼度スコアとターゲット タイプです。 トップ インテントの値には、ターゲット プロジェクトからの実際の応答も含まれます。

projectKind
projectKind string

プロジェクトの種類。

topIntent
topIntent string

最高スコアに伴う意図です。

ExtractiveSummarizationResult

名前 パス 説明
documents
documents array of ExtractedSummaryDocumentResultWithDetectedLanguage

ドキュメント別の応答

ExtractedSummaryDocumentResultWithDetectedLanguage

名前 パス 説明
sentences array of ExtractedSummarySentence

抽出された要約を表すランク付けされた文の一覧です。

detectedLanguage
detectedLanguage DetectedLanguage

ExtractedSummarySentence

名前 パス 説明
text
text string

抽出された文のテキストです。

rankScore
rankScore double

概要内の文の関連性を表す倍精度値。 値が大きいほど、重要度が高いことを示します。

offset
offset integer

パラメーター StringIndexType の値に基づく、ドキュメントの開始からの文オフセットです。

length
length integer

分の長さ。

ExtractiveSummarizationLROResult

名前 パス 説明
results
results ExtractiveSummarizationResult

AbstractiveSummarizationLROResult

抽象要約処理の結果を表すオブジェクトです。

名前 パス 説明
results
results AbstractiveSummarizationResult

各ドキュメントのビルド前の要約処理の結果を表すオブジェクトです。

AbstractiveSummarizationResult

各ドキュメントのビルド前の要約処理の結果を表すオブジェクトです。

名前 パス 説明
documents
documents array of AbstractiveSummaryDocumentResultWithDetectedLanguage

ドキュメント別の応答

AbstractiveSummaryDocumentResultWithDetectedLanguage

検出された言語を含む 1 つのドキュメントの要約処理結果を表すオブジェクトです。

名前 パス 説明
summaries
summaries array of AbstractiveSummary

抽象的な要約の一覧です。

id
id string

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

warnings
warnings array of LanguageDocumentWarning

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

統計
statistics DocumentStatistics

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

detectedLanguage
detectedLanguage DetectedLanguage

SummaryContext

要約のコンテキストです。

名前 パス 説明
offset
offset integer

コンテキストの開始位置。 異なる 'stringIndexType' 値を使用すると、返されるオフセットに影響を与える可能性があります。

length
length integer

コンテキストの長さ。 異なる 'stringIndexType' 値を使用すると、返される長さに影響を与える可能性があります。

AbstractiveSummary

特定のドキュメントのコンテキストを含む単一の要約を表すオブジェクトです。

名前 パス 説明
text
text string

要約のテキストです。

コンテキスト
contexts array of SummaryContext

要約のコンテキストの一覧です。

AnswersResult

質問回答のリストを表します。

名前 パス 説明
回答
answers array of KnowledgeBaseAnswer

回答結果リストを表します。

isUserQuestionAmbiguous
isUserQuestionAmbiguous boolean

ユーザーの質問があいまいな場合はブール値を返します。

KnowledgeBaseAnswer

プロジェクトの回答を表します。

名前 パス 説明
質問
questions array of string

回答と関連した質問の一覧。

回答
answer string

回答のテキスト。

Confidence Threshold
confidenceScore float

自信スコアに答えてください。値の範囲は 0 から 1 です。

QnA ID
id integer

QnA 結果の ID。

ソース
source string

QnA 結果のソース。

メタデータ
metadata object

回答に関連付けられたメタデータ。質問の回答を分類またはフィルタリングするのに役立ちます。

ダイアログ
dialog KnowledgeBaseAnswerDialog

回答に関連付けられたダイアログ。

answerSpan
answerSpan AnswerSpan

QnA の回答スパン オブジェクト。

KnowledgeBaseAnswerDialog

回答に関連付けられたダイアログ。

名前 パス 説明
isContextOnly
isContextOnly boolean

プロンプトが前の質問にのみ関連するかどうかをマークします。 true の場合、コンテキストのないクエリの検索結果としてこの QnA を含めないでください。それ以外の場合、false の場合、コンテキストを無視し、この QnA を検索結果に含めます。

プロンプト
prompts array of KnowledgeBaseAnswerPrompt

回答と関連したプロンプトの一覧。

KnowledgeBaseAnswerPrompt

回答のプロンプト。

名前 パス 説明
displayOrder
displayOrder integer

プロンプトのインデックス - プロンプトの順序付けに使用されます。

qnaId
qnaId integer

プロンプトに対応する QnA ID。

displayText
displayText string

フォローアップ質問プロンプトを表すために表示されるテキスト。

AnswerSpan

QnA の回答スパン オブジェクト。

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

正確な答えの予測テキスト。

Confidence Threshold
confidenceScore float

正確な答えの予測スコア。値の範囲は 0 から 1 です。

オフセット
offset integer

回答の開始からの正確な回答オフセット。

length
length integer

正確な答えの長さ。