Azure Cognitive Service for Language
以前は "Text Analytics" コネクタと呼ばれる Azure Cognitive Service for Language では、指定したテキストの言語、センチメント、その他のテキストが検出されます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Standard | すべての Power Automate リージョン |
| ロジック アプリ | Standard | すべての Logic Apps リージョン |
| Power Apps | Standard | すべての Power Apps リージョン |
| Power Automate | Standard | すべての Power Automate リージョン |
| お問い合わせ | |
|---|---|
| 名前 | Microsoft |
| URL | https://gallery.cortanaanalytics.com/MachineLearningAPI/Text-Analytics-2 |
| mlapi@microsoft.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Microsoft |
| Website | https://azure.microsoft.com/services/cognitive-services/text-analytics/ |
注
このコネクタは、以前は "Text Analytics" または "Microsoft Cognitive Services Text Analytics" と呼ばれていました。
この統合を使用するには、Azure portal で Cognitive Service リソース が必要です。 アプリケーションを認証するためのエンドポイントとキーを取得します。 接続するには、アカウント キーとサイト URL を指定し、[接続の 作成] を選択します。 接続の操作コストについては、 こちらをご覧ください。
これで、この統合の使用を開始する準備ができました。
Microsoft Entra ID を使用した接続
Microsoft Entra ID を使用して接続を作成するには、アクセスするアカウントに Cognitive Services ユーザー ロールを追加する必要があります。 この接続を使用するには、Cognitive Services リソースに関連付けられている一意のサブドメインをサポート操作に入力する必要があります。
Microsoft Entra ID 認証ではサポートされていない操作
Microsoft Entra ID 認証を使用する場合 、V4 アクションのみがサポートされます。 非推奨のアクションは引き続き Access Key 認証で動作しますが、 Microsoft Entra ID 接続で使用すると失敗します。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| API キー | APIキー | すべてのリージョン | 共有可能 |
| 既定 [非推奨] | このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。 | すべてのリージョン | 共有不可 |
API キー
認証 ID: keyBasedAuth
適用対象: すべてのリージョン
APIキー
これは共有可能な接続です。 電源アプリが別のユーザーと共有されている場合は、接続も共有されます。 詳細については、 キャンバス アプリのコネクタの概要 - Power Apps |Microsoft Docs
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| アカウント キー | securestring | Cognitive Services アカウント キー | 正しい |
| サイトの URL | 文字列 | ルート サイトの URL (例: https://westus.api.cognitive.microsoft.com) |
既定 [非推奨]
適用対象: すべてのリージョン
このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| アカウント キー | securestring | Cognitive Services アカウント キー | 正しい |
| サイトの URL | 文字列 | ルート サイトの URL (例: https://westus.api.cognitive.microsoft.com)。 指定しない場合、サイト URL は既定で https://westus.api.cognitive.microsoft.com に設定されます。 |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 1200 | 60 秒 |
アクション
|
Async Abstractive |
要約のためにテキスト ドキュメントのコレクションを送信する |
|
Async Custom |
カスタム エンティティ認識分析用のテキスト ドキュメントのコレクションを送信します。 |
|
Async Custom |
カスタムの単一分類分析用のテキスト ドキュメントのコレクションを送信します。 |
|
Async Custom |
カスタムの単一分類分析用のテキスト ドキュメントのコレクションを送信します。 |
|
Async Entity |
エンティティ リンク分析用のテキスト ドキュメントのコレクションを送信します。 |
|
Async Entity |
エンティティ認識分析用のテキスト ドキュメントのコレクションを送信します。 |
|
Async Extractive |
抽出要約のためにテキスト ドキュメントのコレクションを送信する |
| Async Healthcare (2022-05-01) |
医療分析のためにテキスト ドキュメントのコレクションを送信します。 |
|
Async Key |
キー フレーズ抽出分析用のテキスト ドキュメントのコレクションを送信します。 |
|
Async Pii |
個人エンティティ認識分析用のテキスト ドキュメントのコレクションを送信します。 |
|
Async Sentiment |
感情分析のためにテキスト ドキュメントのコレクションを送信します。 |
| Conversations (CLU) (2022-05-01) |
入力された会話発話を分析します。 |
| Project から回答を生成する |
このアクションは、プロジェクトでナレッジ ベースを使用して、指定された質問に回答するのに役立ちます。 |
| エンティティ [非推奨] |
このアクションは非推奨になりました。 代わりに 名前付きエンティティ認識 (V4) を使用してください。
|
| エンティティ リンク (V3.0) |
この API は、既知のナレッジ ベースへのリンクを含む、認識されたエンティティの一覧を返します。 サポートされている 言語 の一覧については、言語サポートを参照してください。 |
| エンティティ リンク (V3.1) (プレビュー) |
この API は、既知のナレッジ ベースへのリンクを含む、認識されたエンティティの一覧を返します。 サポートされている 言語 の一覧については、言語サポートを参照してください。 |
| エンティティ リンク (V4) (プレビュー) |
この API は、既知のナレッジ ベースへのリンクを含む、認識されたエンティティの一覧を返します。 サポートされている 言語 の一覧については、言語サポートを参照してください。 |
| エンティティの検出 (V2) [非推奨] |
このアクションは非推奨になりました。 代わりに 名前付きエンティティ認識 (V4) を使用してください。
|
| キー フレーズ (V2) [非推奨] |
このアクションは非推奨になりました。 代わりに キー フレーズ (V4) を使用してください。
|
| キー フレーズ (V3.0) |
API は、入力テキスト内のキー フレーズを表す文字列の一覧を返します。 サポートされている言語の一覧については、 キー フレーズ抽出 の言語サポートを参照してください。 |
| キー フレーズ (V3.1) (プレビュー) |
API は、入力テキスト内のキー フレーズを表す文字列の一覧を返します。 サポートされている言語の一覧については、 キー フレーズ抽出 の言語サポートを参照してください。 |
| キー フレーズ (V4) (プレビュー) |
API は、入力テキスト内のキー フレーズを表す文字列の一覧を返します。 サポートされている言語の一覧については、 キー フレーズ抽出 の言語サポートを参照してください。 |
| キー フレーズ [非推奨] |
このアクションは非推奨になりました。 代わりに キー フレーズ (V4) を使用してください。
|
| キー フレーズ [非推奨] |
このアクションは非推奨になりました。 代わりに キー フレーズ (V4) を使用してください。
|
| センチメント (V3.0) |
API は、ドキュメントとその中の各文のセンチメント クラス (Positive、Negative、Neutral) ごとのセンチメント スコアと、センチメント予測を返します。 サポートされている言語の一覧については、 感情分析とオピニオン マイニング 言語のサポートを参照してください。 |
| センチメント (V3.1) (プレビュー) |
API は、入力テキストの詳細なセンチメント分析を返します。 分析は、ドキュメント レベルから文と主要な用語 (ターゲットと評価) まで、複数のレベルの細分性で行われます。 |
| センチメント (V4) (プレビュー) |
API は、入力テキストの詳細なセンチメント分析を返します。 分析は、ドキュメント レベルから文と主要な用語 (ターゲットと評価) まで、複数のレベルの細分性で行われます。 |
| センチメントの検出 (V2) [非推奨] |
このアクションは非推奨になりました。 代わりに センチメント (V4) を使用してください。
|
| センチメントの検出 [非推奨] |
このアクションは非推奨になりました。 代わりに センチメント (V4) を使用してください。
|
| センチメントの検出 [非推奨] |
このアクションは非推奨になりました。 代わりに センチメント (V4) を使用してください。
|
| 会話 (オーケストレーション) (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) を使用してください。
|
| 言語の検出 (V3.0) |
API は、検出された言語と 0 から 1 の数値スコアを返します。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 サポートされている言語の一覧については、 言語検出 の言語サポートを参照してください。 |
| 言語の検出 (V3.1) (プレビュー) |
API は、検出された言語と 0 から 1 の数値スコアを返します。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 サポートされている言語の一覧については、 言語検出 の言語サポートを参照してください。 |
| 言語の検出 (V4) (プレビュー) |
API は、検出された言語と 0 から 1 の数値スコアを返します。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 サポートされている言語の一覧については、 言語検出 の言語サポートを参照してください。 |
| 言語の検出 [非推奨] |
このアクションは非推奨になりました。 代わりに 、言語検出 (V4) を使用してください。
|
| 言語の検出 [非推奨] |
このアクションは非推奨になりました。 代わりに 、言語検出 (V4) を使用してください。
|
| 非同期会話 PII (テキスト) (2022-05-15-preview) |
分析のために会話のコレクションを送信します。 実行する 1 つ以上の一意のタスクを指定します。 |
| 非同期会話 PII (トランスクリプト) (2022-05-15-preview) |
分析のために会話のコレクションを送信します。 実行する 1 つ以上の一意のタスクを指定します。 |
| 非同期会話の要約 (2022-05-15-preview) |
分析のために会話のコレクションを送信します。 実行する 1 つ以上の一意のタスクを指定します。 |
Async AbstractiveSummarization (2022-10-01-preview)
要約のためにテキスト ドキュメントのコレクションを送信する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
|
|
sentenceCount
|
sentenceCount | integer |
出力サマリー内の文の概数を制御します。 |
戻り値
Async CustomEntityRecognition (2022-05-01)
カスタム エンティティ認識分析用のテキスト ドキュメントのコレクションを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
|
|
projectName
|
projectName | True | string |
このフィールドは、モデルのプロジェクト名を示します。 |
|
デプロイメント名
|
deploymentName | True | string |
このフィールドは、モデルのデプロイ名を示します。 |
戻り値
Async CustomMultiLabelClassification (2022-05-01)
カスタムの単一分類分析用のテキスト ドキュメントのコレクションを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
|
|
projectName
|
projectName | True | string |
このフィールドは、モデルのプロジェクト名を示します。 |
|
デプロイメント名
|
deploymentName | True | string |
このフィールドは、モデルのデプロイ名を示します。 |
戻り値
Async CustomSingleLabelClassification (2022-05-01)
カスタムの単一分類分析用のテキスト ドキュメントのコレクションを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
|
|
projectName
|
projectName | True | string |
このフィールドは、モデルのプロジェクト名を示します。 |
|
デプロイメント名
|
deploymentName | True | string |
このフィールドは、モデルのデプロイ名を示します。 |
戻り値
Async EntityLinking (2022-05-01)
エンティティ リンク分析用のテキスト ドキュメントのコレクションを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
Async EntityRecognition (2022-05-01)
エンティティ認識分析用のテキスト ドキュメントのコレクションを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
Async ExtractiveSummarization (2022-10-01-preview)
抽出要約のためにテキスト ドキュメントのコレクションを送信する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
|
|
sentenceCount
|
sentenceCount | integer | ||
|
sortBy
|
sortBy | string |
抽出要約の結果に使用する並べ替え条件。 |
戻り値
Async Healthcare (2022-05-01)
医療分析のためにテキスト ドキュメントのコレクションを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
Async KeyPhrases (2022-05-01)
キー フレーズ抽出分析用のテキスト ドキュメントのコレクションを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
戻り値
Async PiiEntityRecognition (2022-05-01)
個人エンティティ認識分析用のテキスト ドキュメントのコレクションを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
|
|
ドメイン
|
___domain | string |
PII エンティティ認識に使用される PII ドメイン。 |
|
|
piiCategories
|
piiCategories | array of string |
(省略可能) 返す PII カテゴリについて説明します |
戻り値
Async SentimentAnalysis (2022-05-01)
感情分析のためにテキスト ドキュメントのコレクションを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
|
|
opinionMining
|
opinionMining | boolean |
戻り値
Conversations (CLU) (2022-05-01)
入力された会話発話を分析します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
言語
|
language | string |
BCP 47 言語表現の会話項目のオーバーライド言語。 |
|
|
SMS 送信
|
text | True | string |
テキスト入力 |
|
projectName
|
projectName | True | string |
使用するプロジェクトの名前。 |
|
デプロイメント名
|
deploymentName | True | string |
使用するデプロイの名前。 |
|
詳細
|
verbose | boolean |
true の場合、サービスは応答でより詳細な情報を返します。 |
戻り値
会話タスクの結果。
Project から回答を生成する
このアクションは、プロジェクトでナレッジ ベースを使用して、指定された質問に回答するのに役立ちます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロジェクト名
|
projectName | True | string |
これは、使用するプロジェクト名です。 |
|
Question
|
question | string |
プロジェクトに対してクエリを実行するユーザーの質問。 |
|
|
ユーザーID
|
userId | string |
ユーザーを表す一意の識別子です。 |
|
|
ページのトップへ#
|
top | integer |
質問に返される回答の最大数。 |
|
|
信頼度しきい値
|
confidenceScoreThreshold | float |
回答の最小しきい値スコア。 値の範囲は 0 から 1 です。 |
|
|
ランカーの種類
|
rankerType | string |
使用するランカーの種類。 |
|
|
QnA ID
|
qnaId | string |
これは、プロジェクトからフェッチする正確な QnA ID です。 |
|
|
前の QnA ID
|
previousQnaId | integer |
前のターントップ回答の結果 QnA ID。 |
|
|
以前のユーザー クエリ
|
previousUserQuery | string |
前のユーザー クエリ。 |
|
|
キー
|
key | string |
QnA で使用されるメタデータ ディクショナリのメタデータ キー。 |
|
|
value
|
value | string |
QnA で使用されるメタデータ ディクショナリのメタデータ値。 |
|
|
でメタデータを結合する
|
logicalOperation | string |
メタデータ フィルターの対応する論理操作に対して 'OR' または 'AND' を設定します。 |
|
|
ソース フィルター
|
sourceFilter | string |
プロジェクト内のソースの特定のリストのいずれかに関連付けられている QnA を検索します。 |
|
|
結合フィルター
|
logicalOperation | string |
メタデータ フィルターをソース フィルターと結合するために使用される論理操作。 |
|
|
正確な回答を有効にする
|
enable | boolean |
回答スパン予測を有効または無効にします。 |
|
|
信頼度しきい値
|
confidenceScoreThreshold | float |
正確な回答を含めるために必要な最小しきい値スコア。値の範囲は 0 から 1 です。 |
|
|
ページのトップへ#
|
topAnswersWithSpan | integer |
1 から 10 までの正確な回答予測で考慮される上位回答の数。 |
|
|
非構造化ソースを含める
|
includeUnstructuredSources | boolean |
非構造化ソースに対するクエリを有効にするフラグ。 |
|
|
デプロイの名前
|
deploymentName | True | string |
これは、使用するプロジェクトの特定の配置です。 |
|
API バージョン
|
api-version | True | string |
これはクライアント API バージョンです。 |
戻り値
質問の回答の一覧を表します。
- Body
- AnswersResult
エンティティ [非推奨]
このアクションは非推奨になりました。 代わりに 名前付きエンティティ認識 (V4) を使用してください。
特定のドキュメント内の既知のエンティティと一般的な名前付きエンティティ ("Person"、"Location"、"Organization" など) の一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキスト
|
text | string |
分析するテキスト。 |
|
|
Language
|
language | string |
これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es" |
戻り値
- Body
- EntitiesResult
エンティティ リンク (V3.0)
この API は、既知のナレッジ ベースへのリンクを含む、認識されたエンティティの一覧を返します。 サポートされている 言語 の一覧については、言語サポートを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モデルのバージョン
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
統計の表示
|
showStats | boolean |
(省略可能) true に設定すると、応答には入力レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- EntityLinkingResult
エンティティ リンク (V3.1) (プレビュー)
この API は、既知のナレッジ ベースへのリンクを含む、認識されたエンティティの一覧を返します。 サポートされている 言語 の一覧については、言語サポートを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
stringIndexType
|
stringIndexType | string |
(省略可能)文字列オフセットの解釈に使用するメソッドを指定します。 既定では、Unicode v8.0.0 に従って Text 要素 (Graphemes) が使用されます。 詳細については、以下を参照してください。 https://aka.ms/text-analytics-offsets |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- EntityLinkingResult
エンティティ リンク (V4) (プレビュー)
この API は、既知のナレッジ ベースへのリンクを含む、認識されたエンティティの一覧を返します。 サポートされている 言語 の一覧については、言語サポートを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リソース サブドメインまたはリージョン
|
subdomain | True | string |
Azure サブドメインまたは地理的リージョン (westus など) |
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
stringIndexType
|
stringIndexType | string |
(省略可能)文字列オフセットの解釈に使用するメソッドを指定します。 既定では、Unicode v8.0.0 に従って Text 要素 (Graphemes) が使用されます。 詳細については、以下を参照してください。 https://aka.ms/text-analytics-offsets |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- EntityLinkingResult
エンティティの検出 (V2) [非推奨]
このアクションは非推奨になりました。 代わりに 名前付きエンティティ認識 (V4) を使用してください。
特定のドキュメント内の既知のエンティティと一般的な名前付きエンティティ ("Person"、"Location"、"Organization" など) の一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID (アイディー)
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
テキスト
|
text | True | string |
分析するテキスト。 |
|
Language
|
language | string |
これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es" |
戻り値
- Body
- EntitiesResults
キー フレーズ (V2) [非推奨]
このアクションは非推奨になりました。 代わりに キー フレーズ (V4) を使用してください。
各ドキュメントの入力テキスト内の主要な通信ポイントを示す文字列の一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID (アイディー)
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
テキスト
|
text | True | string |
分析するテキスト。 |
|
Language
|
language | string |
これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es" |
戻り値
- Body
- KeyPhraseResults
キー フレーズ (V3.0)
API は、入力テキスト内のキー フレーズを表す文字列の一覧を返します。 サポートされている言語の一覧については、 キー フレーズ抽出 の言語サポートを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モデルのバージョン
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
統計の表示
|
showStats | boolean |
(省略可能) true に設定すると、応答には入力レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- KeyPhraseResultV3
キー フレーズ (V3.1) (プレビュー)
API は、入力テキスト内のキー フレーズを表す文字列の一覧を返します。 サポートされている言語の一覧については、 キー フレーズ抽出 の言語サポートを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- KeyPhraseResult
キー フレーズ (V4) (プレビュー)
API は、入力テキスト内のキー フレーズを表す文字列の一覧を返します。 サポートされている言語の一覧については、 キー フレーズ抽出 の言語サポートを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リソース サブドメインまたはリージョン
|
subdomain | True | string |
Azure サブドメインまたは地理的リージョン (westus など) |
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- KeyPhraseResult
キー フレーズ [非推奨]
このアクションは非推奨になりました。 代わりに キー フレーズ (V4) を使用してください。
入力テキスト内の主要な通信ポイントを表す文字列の一覧を返します。 現在サポートされている言語は、英語、ドイツ語、スペイン語、日本語です。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキスト
|
text | string |
分析するテキスト。 |
|
|
Language
|
language | string |
これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es" |
戻り値
- Body
- KeyPhraseResult
キー フレーズ [非推奨]
このアクションは非推奨になりました。 代わりに キー フレーズ (V4) を使用してください。
入力テキスト内の主要な通信ポイントを表す文字列の一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキスト
|
text | string |
分析するテキスト。 |
|
|
Language
|
language | string |
これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es" |
戻り値
- Body
- KeyPhraseResult
センチメント (V3.0)
API は、ドキュメントとその中の各文のセンチメント クラス (Positive、Negative、Neutral) ごとのセンチメント スコアと、センチメント予測を返します。 サポートされている言語の一覧については、 感情分析とオピニオン マイニング 言語のサポートを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モデルのバージョン
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
統計の表示
|
showStats | boolean |
(省略可能) true に設定すると、応答には入力レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- SentimentResponse
センチメント (V3.1) (プレビュー)
API は、入力テキストの詳細なセンチメント分析を返します。 分析は、ドキュメント レベルから文と主要な用語 (ターゲットと評価) まで、複数のレベルの細分性で行われます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
opinionMining
|
opinionMining | boolean |
(省略可能) true に設定すると、応答にはセンチメント予測だけでなく、オピニオン マイニング (アスペクトベースのセンチメント分析) 結果も含まれます。 |
|
|
stringIndexType
|
stringIndexType | string |
(省略可能)文字列オフセットの解釈に使用するメソッドを指定します。 既定では、Unicode v8.0.0 に従って Text 要素 (Graphemes) が使用されます。 詳細については、以下を参照してください。 https://aka.ms/text-analytics-offsets |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- SentimentResponse
センチメント (V4) (プレビュー)
API は、入力テキストの詳細なセンチメント分析を返します。 分析は、ドキュメント レベルから文と主要な用語 (ターゲットと評価) まで、複数のレベルの細分性で行われます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リソース サブドメインまたはリージョン
|
subdomain | True | string |
Azure サブドメインまたは地理的リージョン (westus など) |
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
opinionMining
|
opinionMining | boolean |
(省略可能) true に設定すると、応答にはセンチメント予測だけでなく、オピニオン マイニング (アスペクトベースのセンチメント分析) 結果も含まれます。 |
|
|
stringIndexType
|
stringIndexType | string |
(省略可能)文字列オフセットの解釈に使用するメソッドを指定します。 既定では、Unicode v8.0.0 に従って Text 要素 (Graphemes) が使用されます。 詳細については、以下を参照してください。 https://aka.ms/text-analytics-offsets |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- SentimentResponse
センチメントの検出 (V2) [非推奨]
このアクションは非推奨になりました。 代わりに センチメント (V4) を使用してください。
各ドキュメントの 0 ~ 1 の数値スコアを返します。 1 に近いスコアは肯定的なセンチメントを示し、0 に近いスコアは否定的なセンチメントを示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID (アイディー)
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
テキスト
|
text | True | string |
分析するテキスト。 |
|
Language
|
language | string |
これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es" |
戻り値
- Body
- SentimentResults
センチメントの検出 [非推奨]
このアクションは非推奨になりました。 代わりに センチメント (V4) を使用してください。
0 ~ 1 の数値スコアを返します。 1 に近いスコアは肯定的なセンチメントを示し、0 に近いスコアは否定的なセンチメントを示します。 現在サポートされている言語は、英語、スペイン語、フランス語、ポルトガル語です。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキスト
|
text | string |
分析するテキスト。 |
|
|
Language
|
language | string |
これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es" |
戻り値
- Body
- SentimentResult
センチメントの検出 [非推奨]
このアクションは非推奨になりました。 代わりに センチメント (V4) を使用してください。
0 ~ 1 の数値スコアを返します。 1 に近いスコアは肯定的なセンチメントを示し、0 に近いスコアは否定的なセンチメントを示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキスト
|
text | string |
分析するテキスト。 |
|
|
Language
|
language | string |
これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es" |
戻り値
- Body
- SentimentResult
会話 (オーケストレーション) (2022-05-01)
入力された会話発話を分析します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
言語
|
language | string |
BCP 47 言語表現の会話項目のオーバーライド言語。 |
|
|
SMS 送信
|
text | True | string |
テキスト入力 |
|
projectName
|
projectName | True | string |
使用するプロジェクトの名前。 |
|
デプロイメント名
|
deploymentName | True | string |
使用するデプロイの名前。 |
|
詳細
|
verbose | boolean |
true の場合、サービスは応答でより詳細な情報を返します。 |
|
|
directTarget
|
directTarget | string |
要求の転送先となるターゲット プロジェクトの名前。 |
|
|
targetProjectParameters
|
targetProjectParameters | object |
各ターゲット プロジェクトのパラメーターを表すディクショナリ。 |
戻り値
会話タスクの結果。
個人情報の検出 (V3.1)
API は、ドキュメント内の個人情報 ("SSN"、"銀行口座" など) を持つエンティティの一覧を返します。 サポートされているエンティティの種類の一覧については、 サポートされている個人を特定できる情報 (PII) エンティティ カテゴリを確認してください。 サポートされている言語の一覧については、 Azure Cognitive Service for Language でサポートされている言語を参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
ドメイン
|
___domain | string |
(省略可能) 指定すると、エンティティ カテゴリのサブセットのみを含むように PII ドメインが設定されます。 使用可能な値は、'PHI'、'none' です。 |
|
|
stringIndexType
|
stringIndexType | string |
(省略可能)文字列オフセットの解釈に使用するメソッドを指定します。 既定では、Unicode v8.0.0 に従って Text 要素 (Graphemes) が使用されます。 詳細については、以下を参照してください。 https://aka.ms/text-analytics-offsets |
|
|
piiCategories
|
piiCategories | array |
(省略可能) 返す PII カテゴリについて説明します |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- PiiResult
個人情報の検出 (V4) (プレビュー)
API は、ドキュメント内の個人情報 ("SSN"、"銀行口座" など) を持つエンティティの一覧を返します。 サポートされているエンティティの種類の一覧については、 サポートされている個人を特定できる情報 (PII) エンティティ カテゴリを確認してください。 サポートされている言語の一覧については、 Azure Cognitive Service for Language でサポートされている言語を参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リソース サブドメインまたはリージョン
|
subdomain | True | string |
Azure サブドメインまたは地理的リージョン (westus など) |
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
ドメイン
|
___domain | string |
(省略可能) 指定すると、エンティティ カテゴリのサブセットのみを含むように PII ドメインが設定されます。 使用可能な値は、'PHI'、'none' です。 |
|
|
stringIndexType
|
stringIndexType | string |
(省略可能)文字列オフセットの解釈に使用するメソッドを指定します。 既定では、Unicode v8.0.0 に従って Text 要素 (Graphemes) が使用されます。 詳細については、以下を参照してください。 https://aka.ms/text-analytics-offsets |
|
|
piiCategories
|
piiCategories | array |
(省略可能) 返す PII カテゴリについて説明します |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
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 |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- EntitiesResultV3
名前付きエンティティ認識 (V3.1) (プレビュー)
この API は、特定のドキュメント内の一般的な名前付きエンティティの一覧を返します。 サポートされているエンティティ型の一覧については、 サポートされている名前付きエンティティ認識 (NER) エンティティ カテゴリを確認してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
stringIndexType
|
stringIndexType | string |
(省略可能)文字列オフセットの解釈に使用するメソッドを指定します。 既定では、Unicode v8.0.0 に従って Text 要素 (Graphemes) が使用されます。 詳細については、以下を参照してください。 https://aka.ms/text-analytics-offsets |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- EntitiesResult
名前付きエンティティ認識 (V4) (プレビュー)
この API は、特定のドキュメント内の一般的な名前付きエンティティの一覧を返します。 サポートされているエンティティ型の一覧については、 サポートされている名前付きエンティティ認識 (NER) エンティティ カテゴリを確認してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リソース サブドメインまたはリージョン
|
subdomain | True | string |
Azure サブドメインまたは地理的リージョン (westus など) |
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
stringIndexType
|
stringIndexType | string |
(省略可能)文字列オフセットの解釈に使用するメソッドを指定します。 既定では、Unicode v8.0.0 に従って Text 要素 (Graphemes) が使用されます。 詳細については、以下を参照してください。 https://aka.ms/text-analytics-offsets |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string |
処理する入力テキスト。 |
|
言語
|
language | string |
(省略可能)これは、言語の 2 文字の ISO 639-1 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。 |
戻り値
- Body
- EntitiesResult
言語の検出 (V2) [非推奨]
このアクションは非推奨になりました。 代わりに 、言語検出 (V4) を使用してください。
検出された言語と、各ドキュメントの 0 ~ 1 の数値スコアを返します。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 合計 120 の言語がサポートされています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID (アイディー)
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
テキスト
|
text | True | string |
分析するテキスト。 |
戻り値
- Body
- LanguageResults
言語の検出 (V3.0)
API は、検出された言語と 0 から 1 の数値スコアを返します。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 サポートされている言語の一覧については、 言語検出 の言語サポートを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モデルのバージョン
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
統計の表示
|
showStats | boolean |
(省略可能) true に設定すると、応答には入力レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string | |
|
countryHint
|
countryHint | string |
戻り値
- Body
- LanguageResultV3
言語の検出 (V3.1) (プレビュー)
API は、検出された言語と 0 から 1 の数値スコアを返します。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 サポートされている言語の一覧については、 言語検出 の言語サポートを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string | |
|
countryHint
|
countryHint | string |
戻り値
- Body
- LanguageResult
言語の検出 (V4) (プレビュー)
API は、検出された言語と 0 から 1 の数値スコアを返します。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 サポートされている言語の一覧については、 言語検出 の言語サポートを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リソース サブドメインまたはリージョン
|
subdomain | True | string |
Azure サブドメインまたは地理的リージョン (westus など) |
|
model-version
|
model-version | string |
(省略可能)この値は、スコア付けに使用されるモデルを示します。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンにする必要があります。 |
|
|
showStats
|
showStats | boolean |
(省略可能) true に設定すると、応答には要求レベルとドキュメント レベルの統計情報が含まれます。 |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(省略可能)true に設定すると、トラブルシューティングのためにテキスト入力がログに記録されるのをオプトアウトします。 既定では、Azure Cognitive Service for Language では、Azure Cognitive Service for Language の自然言語処理機能を提供する際の問題のトラブルシューティングのみを目的として、入力テキストが 48 時間ログに記録されます。 このパラメーターを true に設定すると、入力ログが無効になり、発生した問題を修復する機能が制限される可能性があります。 詳細については、 https://aka.ms/cs-compliance の Cognitive Services のコンプライアンスとプライバシーに関する注意事項と、 https://www.microsoft.com/en-us/ai/responsible-aiの Microsoft 責任ある AI の原則を参照してください。 |
|
|
id
|
id | True | string |
空でない一意のドキュメント識別子。 |
|
SMS 送信
|
text | True | string | |
|
countryHint
|
countryHint | string |
戻り値
- Body
- LanguageResult
言語の検出 [非推奨]
このアクションは非推奨になりました。 代わりに 、言語検出 (V4) を使用してください。
検出された言語と、0 ~ 1 の数値スコアを返します。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 合計 120 の言語がサポートされています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキスト
|
text | string |
分析するテキスト。 |
|
|
言語の数
|
numberOfLanguagesToDetect | integer |
検出する言語の数。 既定では 1 に設定されます。 |
戻り値
- Body
- LanguageResult
言語の検出 [非推奨]
このアクションは非推奨になりました。 代わりに 、言語検出 (V4) を使用してください。
検出された言語と、0 ~ 1 の数値スコアを返します。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 合計 120 の言語がサポートされています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テキスト
|
text | string |
分析するテキスト。 |
戻り値
- Body
- LanguageResult
非同期会話 PII (テキスト) (2022-05-15-preview)
分析のために会話のコレクションを送信します。 実行する 1 つ以上の一意のタスクを指定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
会話アイテムの ID。 |
|
participantId
|
participantId | True | string |
会話アイテムの参加者 ID。 |
|
言語
|
language | string |
BCP 47 言語表現の会話項目のオーバーライド言語。 |
|
|
ロール
|
role | string |
参加者の役割。 |
|
|
SMS 送信
|
text | True | string |
テキスト入力 |
|
言語
|
language | True | string |
BCP-47 形式の会話項目の言語。 |
|
ドメイン
|
___domain | string |
サポートされている会話ドメインの列挙。 |
|
|
loggingOptOut
|
loggingOptOut | boolean | ||
|
piiCategories
|
piiCategories | array of string |
検出のために返す PII カテゴリについて説明します。 指定しない場合、'default' カテゴリが返されます。これは言語によって異なります。 |
戻り値
関連する統計と共に送信された会話分析ジョブの状態を格納します。
非同期会話 PII (トランスクリプト) (2022-05-15-preview)
分析のために会話のコレクションを送信します。 実行する 1 つ以上の一意のタスクを指定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
会話アイテムの ID。 |
|
participantId
|
participantId | True | string |
会話アイテムの参加者 ID。 |
|
言語
|
language | string |
BCP 47 言語表現の会話項目のオーバーライド言語。 |
|
|
ロール
|
role | string |
参加者の役割。 |
|
|
itn
|
itn | string |
入力の逆テキスト正規化表現。 逆テキスト正規化フォームは、Microsoft の Speech to Text API から認識されるテキストであり、電話番号、番号、省略形、およびその他の変換が適用されます。 |
|
|
maskedItn
|
maskedItn | string |
不適切な表現マスクが適用された逆テキスト正規化形式。 |
|
|
SMS 送信
|
text | string |
句読点と大文字と小文字が追加された、音声認識からテキスト API への認識されたテキストの表示形式。 |
|
|
語彙的
|
lexical | string |
実際の単語が認識された音声からテキスト API に認識されるテキストの字句形式。 |
|
|
ワード
|
word | string |
認識された単語。 |
|
|
オフセット
|
offset | integer |
音声オーディオの開始からのオフセット (ティック単位)。 1 ティック = 100 ns。 |
|
|
duration
|
duration | integer |
単語のアーティキュレーションの期間 (ティック単位)。 1 ティック = 100 ns。 |
|
|
言語
|
language | True | string |
BCP-47 形式の会話項目の言語。 |
|
ドメイン
|
___domain | string |
サポートされている会話ドメインの列挙。 |
|
|
loggingOptOut
|
loggingOptOut | boolean | ||
|
piiCategories
|
piiCategories | array of string |
検出のために返す PII カテゴリについて説明します。 指定しない場合、'default' カテゴリが返されます。これは言語によって異なります。 |
|
|
includeAudioRedaction
|
includeAudioRedaction | boolean |
オーディオの編集が要求されたかどうかを示すフラグ。 既定では、オーディオの編集は実行されません。 |
|
|
redactionSource
|
redactionSource | string |
サポートされているトランスクリプト コンテンツ タイプの列挙。 |
戻り値
関連する統計と共に送信された会話分析ジョブの状態を格納します。
非同期会話の要約 (2022-05-15-preview)
分析のために会話のコレクションを送信します。 実行する 1 つ以上の一意のタスクを指定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | string |
会話アイテムの ID。 |
|
participantId
|
participantId | True | string |
会話アイテムの参加者 ID。 |
|
言語
|
language | string |
BCP 47 言語表現の会話項目のオーバーライド言語。 |
|
|
ロール
|
role | string |
参加者の役割。 |
|
|
SMS 送信
|
text | True | string |
テキスト入力 |
|
言語
|
language | True | string |
BCP-47 形式の会話項目の言語。 |
|
ドメイン
|
___domain | string |
サポートされている会話ドメインの列挙。 |
|
|
loggingOptOut
|
loggingOptOut | boolean | ||
|
summaryAspects
|
summaryAspects | True | array of string |
戻り値
関連する統計と共に送信された会話分析ジョブの状態を格納します。
定義
ConversationalPIITranscriptJobState
関連する統計と共に送信された会話分析ジョブの状態を格納します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ディスプレイ名
|
displayName | string | |
|
createdDateTime
|
createdDateTime | date-time | |
|
expirationDateTime
|
expirationDateTime | date-time | |
|
jobId
|
jobId | string | |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time | |
|
状態
|
status | string | |
|
エラー
|
errors | array of Error | |
|
nextLink
|
nextLink | string | |
|
statistics
|
statistics | ConversationRequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
完了
|
tasks.completed | integer |
正常に完了したタスクの数。 |
|
失敗
|
tasks.failed | integer |
失敗したタスクの数。 |
|
inProgress
|
tasks.inProgress | integer |
現在進行中のタスクの数。 |
|
トータル
|
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 |
空でない一意の会話識別子。 |
|
警告
|
conversations.warnings | array of InputWarning |
ドキュメントの処理中に発生した警告。 |
|
statistics
|
conversations.statistics | ConversationStatistics |
要求で showStats=true が指定された場合、このフィールドには会話ペイロードに関する情報が含まれます。 |
|
エラー
|
errors | array of InputError |
ドキュメント ID 別のエラー。 |
|
statistics
|
statistics | RequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
modelVersion
|
modelVersion | string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
InputError
ジョブの実行中に発生したエラーの詳細が含まれます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
入力の ID。 |
|
エラー
|
error | Error |
エラー オブジェクト。 |
InputWarning
ジョブの実行中に発生した警告の詳細が含まれます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | string |
警告コード。 |
|
メッセージ
|
message | string |
警告メッセージ。 |
|
targetRef
|
targetRef | string |
ターゲット オブジェクトを示す JSON ポインター参照。 |
ConversationStatistics
要求で showStats=true が指定された場合、このフィールドには会話ペイロードに関する情報が含まれます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
transactionsCount
|
transactionsCount | integer |
要求のテキスト単位の数。 |
ConversationPIITranscriptItemResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string | |
|
redactedContent
|
redactedContent | ConversationalPIITranscriptRedactedTranscriptContent |
サービスによって生成され、必要なすべての個人を特定できる情報が編集されたトランスクリプト コンテンツ応答。 |
|
エンティティ
|
entities | array of Entity |
ConversationalPIITranscriptRedactedTranscriptContent
サービスによって生成され、必要なすべての個人を特定できる情報が編集されたトランスクリプト コンテンツ応答。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
itn
|
itn | string |
逆テキスト正規化形式入力の編集済み出力。 |
|
maskedItn
|
maskedItn | string |
マスクされた逆テキスト正規化形式入力の編集済み出力。 |
|
SMS 送信
|
text | string |
テキスト (Microsoft の Speech to Text 'display') 形式の入力用に編集された出力。 |
|
語彙的
|
lexical | string |
字句形式入力の編集済み出力。 |
|
audioTimings
|
audioTimings | array of AudioTiming |
編集されたオーディオ セグメントの一覧。 |
AudioTiming
オーディオのタイミング情報。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
オフセット
|
offset | integer |
音声オーディオの開始からのオフセット (ティック単位)。 1 ティック = 100 ns。 |
|
duration
|
duration | integer |
単語のアーティキュレーションの期間 (ティック単位)。 1 ティック = 100 ns。 |
ConversationalPIITextJobState
関連する統計と共に送信された会話分析ジョブの状態を格納します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ディスプレイ名
|
displayName | string | |
|
createdDateTime
|
createdDateTime | date-time | |
|
expirationDateTime
|
expirationDateTime | date-time | |
|
jobId
|
jobId | string | |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time | |
|
状態
|
status | string | |
|
エラー
|
errors | array of Error | |
|
nextLink
|
nextLink | string | |
|
statistics
|
statistics | ConversationRequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
完了
|
tasks.completed | integer |
正常に完了したタスクの数。 |
|
失敗
|
tasks.failed | integer |
失敗したタスクの数。 |
|
inProgress
|
tasks.inProgress | integer |
現在進行中のタスクの数。 |
|
トータル
|
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 |
空でない一意の会話識別子。 |
|
警告
|
conversations.warnings | array of InputWarning |
ドキュメントの処理中に発生した警告。 |
|
statistics
|
conversations.statistics | ConversationStatistics |
要求で showStats=true が指定された場合、このフィールドには会話ペイロードに関する情報が含まれます。 |
|
エラー
|
errors | array of InputError |
ドキュメント ID 別のエラー。 |
|
statistics
|
statistics | RequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
modelVersion
|
modelVersion | string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
ConversationPIITextItemResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string | |
|
redactedContent
|
redactedContent | ConversationalPIITranscriptRedactedTextContent |
サービスによって生成され、必要なすべての個人を特定できる情報が編集されたトランスクリプト コンテンツ応答。 |
|
エンティティ
|
entities | array of Entity |
ConversationalPIITranscriptRedactedTextContent
サービスによって生成され、必要なすべての個人を特定できる情報が編集されたトランスクリプト コンテンツ応答。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SMS 送信
|
text | string |
テキスト (Microsoft の Speech to Text 'display') 形式の入力用に編集された出力。 |
AnalyzeConversationSummarizationJobState
関連する統計と共に送信された会話分析ジョブの状態を格納します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ディスプレイ名
|
displayName | string | |
|
createdDateTime
|
createdDateTime | date-time | |
|
expirationDateTime
|
expirationDateTime | date-time | |
|
jobId
|
jobId | string | |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time | |
|
状態
|
status | string | |
|
エラー
|
errors | array of Error | |
|
nextLink
|
nextLink | string | |
|
statistics
|
statistics | ConversationRequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
完了
|
tasks.completed | integer |
正常に完了したタスクの数。 |
|
失敗
|
tasks.failed | integer |
失敗したタスクの数。 |
|
inProgress
|
tasks.inProgress | integer |
現在進行中のタスクの数。 |
|
トータル
|
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 |
空でない一意の会話識別子。 |
|
警告
|
conversations.warnings | array of InputWarning |
ドキュメントの処理中に発生した警告。 |
|
statistics
|
conversations.statistics | ConversationStatistics |
要求で showStats=true が指定された場合、このフィールドには会話ペイロードに関する情報が含まれます。 |
|
エラー
|
errors | array of InputError |
ドキュメント ID 別のエラー。 |
|
statistics
|
statistics | RequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
modelVersion
|
modelVersion | string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
SummaryResultItem
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アスペクト
|
aspect | string | |
|
SMS 送信
|
text | string |
エラー
エラー オブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | ErrorCode |
人間が判読できるエラー コード。 |
|
メッセージ
|
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. |
ErrorCode
InnerErrorModel
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | InnerErrorCode |
人間が判読できるエラー コード。 |
|
メッセージ
|
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. |
内部エラーコード
LanguageCustomEntitiesResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of LanguageEntitiesDocumentResult |
ドキュメント別の応答 |
LanguageCustomLabelClassificationResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of LanguageClassificationDocumentResult |
ドキュメント別の応答 |
LanguageClassificationResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カテゴリ
|
category | string |
分類の種類。 |
|
confidenceScore
|
confidenceScore | double |
認識されたクラスの 0 から 1 までの信頼度スコア。 |
LanguageClassificationDocumentResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
クラス
|
class | array of LanguageClassificationResult | |
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
LanguageHealthcareResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of LanguageHealthcareEntitiesDocumentResult |
LanguageHealthcareEntitiesDocumentResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エンティティ
|
entities | array of LanguageHealthcareEntity |
医療エンティティ。 |
|
relations
|
relations | array of LanguageHealthcareRelation |
医療エンティティの関係。 |
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
LanguageHealthcareEntity
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SMS 送信
|
text | string |
要求に表示されるエンティティ テキスト。 |
|
カテゴリ
|
category | string |
医療エンティティ カテゴリ。 |
|
サブカテゴリ
|
subcategory | string |
(省略可能)エンティティのサブタイプ。 |
|
オフセット
|
offset | integer |
エンティティ テキストの開始位置。 異なる 'stringIndexType' 値を使用すると、返されるオフセットに影響する可能性があります。 |
|
length
|
length | integer |
エンティティ テキストの長さ。 異なる 'stringIndexType' 値を使用すると、返される長さに影響する可能性があります。 |
|
confidenceScore
|
confidenceScore | double |
抽出されたエンティティの 0 から 1 までの信頼度スコア。 |
|
アサーション
|
assertion | LanguageHealthcareAssertion | |
|
名前
|
name | string |
エンティティの優先名。 例: '組織学的' は 'histologic' の 'name' を持つことになります。 |
|
links
|
links | array of LanguageHealthcareEntityLink |
既知のデータ ソース内のエンティティ参照。 |
LanguageHealthcareRelation
すべてのリレーションシップは、特定の relationType のエンティティ グラフであり、すべてのエンティティが接続され、リレーションシップ コンテキスト内で特定のロールを持ちます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
relationType
|
relationType | string |
リレーションシップの種類。 たとえば、 |
|
エンティティ
|
entities | array of LanguageHealthcareRelationEntity |
リレーションシップ内のエンティティ。 |
LanguageHealthcareAssertion
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コンディショナリティ
|
conditionality | string |
エンティティの条件付きについて説明します。 |
|
確実
|
certainty | string |
エンティティの確実性と極性について説明します。 |
|
関連付け
|
association | string |
エンティティがテキストの件名であるか、または他のユーザーを記述しているかどうかを説明します。 |
LanguageHealthcareRelationEntity
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
参照
|
ref | string |
エンティティを指す JSON ポインター RFC 6901 (URI フラグメント識別子表現) を使用した参照リンク オブジェクト。 |
|
ロール
|
role | string |
リレーションシップ内のエンティティのロール。 例えば、「CD20陽性拡散大B細胞リンパ腫」は、かっこ内の役割を持つ以下のエンティティを有する:CD20(GeneOrタンパク質)、陽性(発現)、拡散性の大きいB細胞リンパ腫(診断)。 |
LanguageHealthcareEntityLink
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
dataSource
|
dataSource | string |
エンティティ カタログ。 たとえば、UMLS、CHV、MSH などです。 |
|
id
|
id | string |
指定されたソース カタログ内のエンティティ ID。 |
LanguageSentimentResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
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
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SMS 送信
|
text | string |
文のテキスト。 |
|
センチメント
|
sentiment | string |
文の予測センチメント。 |
|
confidenceScores
|
confidenceScores | LanguageSentimentConfidenceScorePerLabel |
すべてのセンチメント クラス (正、中立、負) の 0 から 1 の信頼度スコアを表します。 |
|
オフセット
|
offset | integer |
文書の先頭からの文のオフセット。 |
|
length
|
length | integer |
文の長さ。 |
|
targets
|
targets | array of LanguageSentenceTarget |
文の対象となる文の配列。 |
|
アセスメント
|
assessments | array of LanguageSentenceAssessment |
文の評価の配列。 |
LanguageSentenceTarget
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
センチメント
|
sentiment | string |
文内の対象となるセンチメント。 |
|
confidenceScores
|
confidenceScores | LanguageTargetConfidenceScoreLabel |
すべてのセンチメント クラス (正と負) の信頼度スコアを表します。 |
|
オフセット
|
offset | integer |
文の先頭からのターゲット オフセット。 |
|
length
|
length | integer |
ターゲットの長さ。 |
|
SMS 送信
|
text | string |
ターゲット テキストが検出されました。 |
|
relations
|
relations | array of LanguageTargetRelation |
ターゲットに関連する評価オブジェクトまたはターゲット オブジェクトの配列。 |
LanguageSentenceAssessment
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
センチメント
|
sentiment | string |
文内の評価センチメント。 |
|
confidenceScores
|
confidenceScores | LanguageTargetConfidenceScoreLabel |
すべてのセンチメント クラス (正と負) の信頼度スコアを表します。 |
|
オフセット
|
offset | integer |
文の先頭からの評価オフセット。 |
|
length
|
length | integer |
評価の長さ。 |
|
SMS 送信
|
text | string |
評価テキストが検出されました。 |
|
isNegated
|
isNegated | boolean |
評価が否定されているかどうかを表すインジケーター。 |
LanguageTargetRelation
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
relationType
|
relationType | string |
ターゲットに関連する型。 |
|
参照
|
ref | string |
リンクされたオブジェクトを示す JSON ポインター。 |
LanguageTargetConfidenceScoreLabel
すべてのセンチメント クラス (正と負) の信頼度スコアを表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
＋
|
positive | double |
肯定的なセンチメントの信頼度スコア |
|
－
|
negative | double |
否定的なセンチメントの信頼度スコア |
LanguageEntitiesResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of LanguageEntitiesDocumentResult |
ドキュメント別の応答 |
LanguageEntitiesDocumentResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エンティティ
|
entities | array of LanguageEntity |
ドキュメント内で認識されるエンティティ。 |
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
LanguageEntity
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SMS 送信
|
text | string |
要求に表示されるエンティティ テキスト。 |
|
カテゴリ
|
category | string |
エンティティの種類です。 |
|
サブカテゴリ
|
subcategory | string |
(省略可能)エンティティのサブタイプ。 |
|
オフセット
|
offset | integer |
エンティティ テキストの開始位置。 異なる 'stringIndexType' 値を使用すると、返されるオフセットに影響する可能性があります。 |
|
length
|
length | integer |
エンティティ テキストの長さ。 異なる 'stringIndexType' 値を使用すると、返される長さに影響する可能性があります。 |
|
confidenceScore
|
confidenceScore | double |
抽出されたエンティティの 0 から 1 までの信頼度スコア。 |
LanguageEntityLinkingResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of LanguageLinkedEntitiesDocumentResult |
ドキュメント別の応答 |
LanguageLinkedEntitiesDocumentResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エンティティ
|
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 |
認識されたエンティティの Entity Search API の一意識別子をBingします。 |
LanguageMatch
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
confidenceScore
|
confidenceScore | double |
既知の項目が認識された場合は、0 ~ 1 の信頼レベルを示す 10 進数が返されます。 |
|
SMS 送信
|
text | string |
要求に表示されるエンティティ テキスト。 |
|
オフセット
|
offset | integer |
エンティティ一致テキストの開始位置。 |
|
length
|
length | integer |
エンティティ一致テキストの長さ。 |
LanguagePiiResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of LanguagePiiEntitiesDocumentResult |
ドキュメント別の応答 |
LanguagePiiEntitiesDocumentResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
redactedText
|
redactedText | string |
編集されたテキストを返します。 |
|
エンティティ
|
entities | array of LanguageEntity |
ドキュメント内で認識されるエンティティ。 |
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
LanguageKeyPhraseResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of LanguageKeyPhrasesDocumentResult |
ドキュメント別の応答 |
LanguageKeyPhrasesDocumentResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
keyPhrases
|
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 | string |
エラー コード。 |
|
メッセージ
|
message | string |
警告メッセージ。 |
|
targetRef
|
targetRef | string |
ターゲット オブジェクトを示す JSON ポインター参照。 |
DocumentError
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
ドキュメント ID。 |
|
エラー
|
error | TextAnalyticsError |
TextAnalyticsError
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | string |
エラー コード。 |
|
メッセージ
|
message | string |
エラー メッセージ。 |
|
ターゲット
|
target | string |
エラーターゲット。 |
|
innererror
|
innererror | InnerError | |
|
details
|
details | array of TextAnalyticsError |
この報告されたエラーの原因となった特定のエラーの詳細。 |
TextAnalyticsWarning
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | string |
エラー コード。 |
|
メッセージ
|
message | string |
警告メッセージ。 |
|
targetRef
|
targetRef | string |
ターゲット オブジェクトを示す JSON ポインター参照。 |
InnerError
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | string |
エラー コード。 |
|
メッセージ
|
message | string |
エラー メッセージ。 |
|
details
|
details | object |
エラーの詳細。 |
|
ターゲット
|
target | string |
エラーターゲット。 |
|
innererror
|
innererror | InnerError |
SentimentResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of DocumentSentiment |
ドキュメントごとの感情分析。 |
|
エラー
|
errors | array of DocumentError |
ドキュメント ID 別のエラー。 |
|
statistics
|
statistics | RequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
modelVersion
|
modelVersion | string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
DocumentSentiment
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
|
センチメント
|
sentiment | string |
ドキュメントの予測センチメント (負、中立、正、または混合)。 |
|
statistics
|
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
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SMS 送信
|
text | string |
文のテキスト。 |
|
センチメント
|
sentiment | string |
文の予測センチメント。 |
|
confidenceScores
|
confidenceScores | SentimentConfidenceScorePerLabel |
すべてのセンチメント クラス (正、中立、負) の 0 から 1 の信頼度スコアを表します。 |
|
オフセット
|
offset | integer |
文書の先頭からの文のオフセット。 |
|
length
|
length | integer |
Unicode 標準による文の長さ。 |
DocumentEntities
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
|
エンティティ
|
entities | array of Entity |
ドキュメント内で認識されるエンティティ。 |
|
警告
|
warnings | array of TextAnalyticsWarning |
ドキュメントの処理中に発生した警告。 |
|
statistics
|
statistics | DocumentStatistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
PiiDocumentEntities
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
|
redactedText
|
redactedText | string |
編集されたテキストを返します。 |
|
エンティティ
|
entities | array of Entity |
ドキュメント内で認識されるエンティティ。 |
|
警告
|
warnings | array of TextAnalyticsWarning |
ドキュメントの処理中に発生した警告。 |
|
statistics
|
statistics | DocumentStatistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
エンティティ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SMS 送信
|
text | string |
要求に表示されるエンティティ テキスト。 |
|
カテゴリ
|
category | string |
エンティティの種類 (Person/Location/Org/SSN など) |
|
サブカテゴリ
|
subcategory | string |
Age/Year/TimeRange などのエンティティ サブタイプ |
|
オフセット
|
offset | integer |
エンティティ テキストの開始位置 (Unicode 文字)。 |
|
length
|
length | integer |
エンティティ テキストの長さ (Unicode 文字)。 |
|
confidenceScore
|
confidenceScore | double |
抽出されたエンティティの 0 から 1 までの信頼度スコア。 |
EntityLinkingResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of DocumentLinkedEntities |
ドキュメント別の応答 |
|
エラー
|
errors | array of DocumentError |
ドキュメント ID 別のエラー。 |
|
statistics
|
statistics | RequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
modelVersion
|
modelVersion | string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
DocumentLinkedEntities
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
|
エンティティ
|
entities | array of LinkedEntity |
ドキュメント内で認識された既知のエンティティ。 |
|
警告
|
warnings | array of TextAnalyticsWarning |
ドキュメントの処理中に発生した警告。 |
|
statistics
|
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 |
既知の項目が認識された場合は、0 ~ 1 の信頼レベルを示す 10 進数が返されます。 |
|
SMS 送信
|
text | string |
要求に表示されるエンティティ テキスト。 |
|
オフセット
|
offset | integer |
エンティティ一致テキストの開始位置 (Unicode 文字)。 |
|
length
|
length | integer |
エンティティ一致テキストの長さ (Unicode 文字)。 |
DocumentKeyPhrases
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
|
keyPhrases
|
keyPhrases | array of string |
代表的な単語または語句の一覧。 返されるキー フレーズの数は、入力ドキュメント内の単語数に比例します。 |
|
警告
|
warnings | array of TextAnalyticsWarning |
ドキュメントの処理中に発生した警告。 |
|
statistics
|
statistics | DocumentStatistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
DocumentLanguage
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
|
detectedLanguage
|
detectedLanguage | DetectedLanguage | |
|
警告
|
warnings | array of TextAnalyticsWarning |
ドキュメントの処理中に発生した警告。 |
|
statistics
|
statistics | DocumentStatistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
DetectedLanguage
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
検出された言語の長い名前 (英語、フランス語など)。 |
|
iso6391Name
|
iso6391Name | string |
ISO 639-1 標準 (en、fr など) に従って検出された言語の 2 文字の表現。 |
|
confidenceScore
|
confidenceScore | double |
0 ~ 1 の信頼度スコア。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 |
KeyPhraseResultV3
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of DocumentKeyPhrases |
ドキュメント別の応答 |
|
エラー
|
errors | array of DocumentError |
ドキュメント ID 別のエラー。 |
|
statistics
|
statistics | RequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
modelVersion
|
modelVersion | string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
EntitiesResultV3
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of DocumentEntities |
ドキュメント別の応答 |
|
エラー
|
errors | array of DocumentError |
ドキュメント ID 別のエラー。 |
|
statistics
|
statistics | RequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
modelVersion
|
modelVersion | string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
PiiResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of PiiDocumentEntities |
ドキュメント別の応答 |
|
エラー
|
errors | array of DocumentError |
ドキュメント ID 別のエラー。 |
|
statistics
|
statistics | RequestStatistics |
要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。 |
|
modelVersion
|
modelVersion | string |
このフィールドは、スコアリングに使用されるモデルを示します。 |
LanguageResultV3
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of DocumentLanguage |
ドキュメント別の応答 |
|
エラー
|
errors | array of DocumentError |
ドキュメント ID 別のエラー。 |
|
statistics
|
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
|
entities | array of object |
Web 上の詳細情報 (Wikipedia と Bing) へのリンクを含む明確なエンティティの一覧。 |
|
名前
|
entities.name | string |
エンティティの名前。 |
|
一致します
|
entities.matches | array of object |
エンティティの一致の一覧。 |
|
items
|
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
|
score | double |
ドキュメントのセンチメントを示す 0 ~ 1 の 10 進数。 通常、0.7 を超えるスコアは肯定的なドキュメントを指し、0.3 未満のスコアは通常は負の意味合いを持っています。 中間値はニュートラル テキストを参照します。 |
|
ID (アイディー)
|
id | string |
一意のドキュメント識別子。 |
DetectedLanguageV2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
検出された言語の長い名前 (英語、フランス語など)。 |
|
言語コード
|
iso6391Name | string |
ISO 639-1 標準 (en、fr など) に従って検出された言語の 2 文字の表現。 |
|
Score
|
score | double |
0 ~ 1 の信頼度スコア。 1 に近いスコアは、識別された言語が true であることを 100% 確実に示します。 |
AnalyzeConversationTaskResultsKind
ConversationalTaskResult
会話タスクの結果。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
kind
|
kind | AnalyzeConversationTaskResultsKind |
サポートされている会話型タスクの結果の列挙 |
|
結果
|
result | AnalyzeConversationResult |
会話分析応答を表します。 |
ConversationalTaskResult_Orchestration
会話タスクの結果。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
kind
|
kind | AnalyzeConversationTaskResultsKind |
サポートされている会話型タスクの結果の列挙 |
|
結果
|
result | AnalyzeConversationResult_Orchestration |
会話分析応答を表します。 |
AnalyzeConversationResult
会話分析応答を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
クエリ
|
query | string |
呼び出し元によって指定された会話発話。 |
|
detectedLanguage
|
detectedLanguage | string |
BCP 47 言語表現でクエリの言語が検出されました。. |
|
予測
|
prediction | ConversationPrediction |
Conversation プロジェクトの予測セクションを表します。 |
AnalyzeConversationResult_Orchestration
会話分析応答を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
クエリ
|
query | string |
呼び出し元によって指定された会話発話。 |
|
detectedLanguage
|
detectedLanguage | string |
BCP 47 言語表現でクエリの言語が検出されました。. |
|
予測
|
prediction | OrchestrationPrediction |
これは、オーケストレーション プロジェクトの予測結果を表します。 |
ConversationPrediction
Conversation プロジェクトの予測セクションを表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
意図
|
intents | array of ConversationIntent |
意図分類の結果。 |
|
エンティティ
|
entities | array of ConversationEntity |
エンティティ抽出の結果。 |
|
プロジェクトの種類
|
projectKind | string |
プロジェクトの種類。 |
|
topIntent
|
topIntent | string |
スコアが最も高い意図。 |
ConversationIntent
Conversation プロジェクトの意図分類の結果。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カテゴリ
|
category | string |
予測されたクラス。 |
|
confidenceScore
|
confidenceScore | float |
クラスの信頼度スコア (0.0 から 1.0)。 |
ConversationEntity
Conversation プロジェクトのエンティティ抽出結果。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カテゴリ
|
category | string |
エンティティ カテゴリ。 |
|
SMS 送信
|
text | string |
予測されたエンティティ テキスト。 |
|
オフセット
|
offset | integer |
クエリ内のこのエンティティの開始インデックス。 |
|
length
|
length | integer |
テキストの長さ。 |
|
confidenceScore
|
confidenceScore | float |
エンティティ信頼度スコア。 |
|
解像 度
|
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 | object |
すべての意図を含むディクショナリ。 キーは意図名であり、値は信頼度スコアとターゲットの種類です。 最上位の意図の値には、ターゲット プロジェクトからの実際の応答も含まれます。 |
|
プロジェクトの種類
|
projectKind | string |
プロジェクトの種類。 |
|
topIntent
|
topIntent | string |
スコアが最も高い意図。 |
ExtractiveSummarizationResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of ExtractedSummaryDocumentResultWithDetectedLanguage |
ドキュメント別の応答 |
ExtractedSummaryDocumentResultWithDetectedLanguage
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
文章
|
sentences | array of ExtractedSummarySentence |
抽出された要約を表す文のランク付けされたリスト。 |
|
detectedLanguage
|
detectedLanguage | DetectedLanguage |
ExtractedSummarySentence
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SMS 送信
|
text | string |
抽出された文のテキスト。 |
|
rankScore
|
rankScore | double |
要約内の文の関連性を表す double 値。 値が大きいほど、重要度が高いことを示します。 |
|
オフセット
|
offset | integer |
パラメーター StringIndexType の値に基づく、ドキュメントの先頭からの文オフセット。 |
|
length
|
length | integer |
文の長さ。 |
ExtractiveSummarizationLROResult
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
results
|
results | ExtractiveSummarizationResult |
AbstractiveSummarizationLROResult
抽象要約タスクの結果を表すオブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
results
|
results | AbstractiveSummarizationResult |
各ドキュメントのビルド前の要約結果を表すオブジェクト。 |
AbstractiveSummarizationResult
各ドキュメントのビルド前の要約結果を表すオブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書類
|
documents | array of AbstractiveSummaryDocumentResultWithDetectedLanguage |
ドキュメント別の応答 |
AbstractiveSummaryDocumentResultWithDetectedLanguage
検出された言語を持つ 1 つのドキュメントの集計結果を表すオブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
summaries
|
summaries | array of AbstractiveSummary |
抽象的な概要の一覧。 |
|
id
|
id | string |
空でない一意のドキュメント識別子。 |
|
警告
|
warnings | array of LanguageDocumentWarning |
ドキュメントの処理中に発生した警告。 |
|
statistics
|
statistics | DocumentStatistics |
要求で showStats=true が指定された場合、このフィールドにはドキュメント ペイロードに関する情報が含まれます。 |
|
detectedLanguage
|
detectedLanguage | DetectedLanguage |
SummaryContext
概要のコンテキスト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
オフセット
|
offset | integer |
コンテキストの開始位置。 異なる 'stringIndexType' 値を使用すると、返されるオフセットに影響する可能性があります。 |
|
length
|
length | integer |
コンテキストの長さ。 異なる 'stringIndexType' 値を使用すると、返される長さに影響する可能性があります。 |
AbstractiveSummary
特定のドキュメントのコンテキストを持つ単一の概要を表すオブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SMS 送信
|
text | string |
概要のテキスト。 |
|
contexts
|
contexts | array of SummaryContext |
概要のコンテキスト リスト。 |
AnswersResult
質問の回答の一覧を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
answers
|
answers | array of KnowledgeBaseAnswer |
回答結果の一覧を表します。 |
|
isUserQuestionAmbiguous
|
isUserQuestionAmbiguous | boolean |
ユーザーの質問があいまいな場合は、ブール値を返します。 |
KnowledgeBaseAnswer
プロジェクトの回答を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
問
|
questions | array of string |
回答に関連付けられている質問の一覧。 |
|
答える
|
answer | string |
回答テキスト。 |
|
信頼度しきい値
|
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 の回答スパン オブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SMS 送信
|
text | string |
正確な回答の予測テキスト。 |
|
信頼度しきい値
|
confidenceScore | float |
正確な回答の予測スコア。値の範囲は 0 から 1 です。 |
|
オフセット
|
offset | integer |
回答の先頭からの正確な回答オフセット。 |
|
length
|
length | integer |
正確な回答の長さ。 |