適用於語言的 Azure 認知服務
Azure Cognitive Service for Language，先前稱為「文字分析」連接器，可偵測您提供的語言、情緒和更多文字。
此連接器適用於以下產品和區域：
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 標準 | 所有 Power Automate 區域 |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域 |
| Power Apps | 標準 | 所有 Power Apps 區域 |
| Power Automate（自動化服務） | 標準 | 所有 Power Automate 區域 |
| 連絡人 | |
|---|---|
| 名稱 | Microsoft |
| URL | https://gallery.cortanaanalytics.com/MachineLearningAPI/Text-Analytics-2 |
| mlapi@microsoft.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | Microsoft |
| 網站 | https://azure.microsoft.com/services/cognitive-services/text-analytics/ |
備註
此連接器先前稱為「文字分析」或「Microsoft 認知服務文字分析」。
若要使用此整合，您需要 Azure 入口網站中的 認知服務資源 。 您將獲得一個端點和一個用於驗證應用程式的金鑰。 若要建立連線，請提供帳戶金鑰、網站 URL，然後選取 建立連線。 有關連線的營運成本，請 在此處深入瞭解。
您現在已準備好開始使用此整合。
與 Microsoft Entra ID 連線
若要建立與 Microsoft Entra ID 的連線，您必須將認知服務使用者角色新增至您的帳戶才能存取。 若要使用此連線，您必須將與認知服務資源相關聯的唯一子網域輸入支援作業。
Microsoft Entra ID 驗證不支援的作業
使用 Microsoft Entra ID 驗證時， 僅支援 V4 動作。 已取代的動作會繼續與驗證搭配 Access Key 使用， 但如果與 Microsoft Entra ID 連線搭配使用，則會失敗。
正在建立連線
連接器支援下列驗證類型：
| API 金鑰 | API 金鑰 (ApiKey) | 所有區域 | 可共用 |
| 預設值 [已棄用] | 此選項僅適用於沒有明確驗證類型的舊連線，並且僅用於回溯相容性。 | 所有區域 | 不可共享 |
API 金鑰
驗證 ID：keyBasedAuth
適用：所有地區
API 金鑰 (ApiKey)
這是可共享的連接。 如果 Power App 與其他使用者共用，也會共用連線。 如需詳細資訊，請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 帳戶金鑰 | securestring | 認知服務帳戶金鑰 | 對 |
| 網站 URL | 字串 | 根網站網址 （範例： https://westus.api.cognitive.microsoft.com） |
預設值 [已棄用]
適用：所有地區
此選項僅適用於沒有明確驗證類型的舊連線，並且僅用於回溯相容性。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 帳戶金鑰 | securestring | 認知服務帳戶金鑰 | 對 |
| 網站 URL | 字串 | 根網站網址 （範例： https://westus.api.cognitive.microsoft.com）。 如果未指定，網站網址將預設為 https://westus.api.cognitive.microsoft.com。 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 1200 | 60 秒 |
動作
| 偵測個人資訊 （V3.1） |
API 會傳回文件中包含個人資訊 （「SSN」、「銀行帳戶」等） 的實體清單。 如需支援的實體類型清單，請檢查支援的 個人識別資訊 （PII） 實體類別。 如需支援的語言清單，請參閱適用於 語言的 Azure 認知服務中支援的語言 。 |
| 偵測個人資訊 （V4） （預覽版） |
API 會傳回文件中包含個人資訊 （「SSN」、「銀行帳戶」等） 的實體清單。 如需支援的實體類型清單，請檢查支援的 個人識別資訊 （PII） 實體類別。 如需支援的語言清單，請參閱適用於 語言的 Azure 認知服務中支援的語言 。 |
| 偵測實體 （V2） [已淘汰] |
此動作已被取代。 請改用具名實體辨識 （V4）。
|
| 偵測情緒 [已棄用] |
此動作已被取代。 請改用情緒 （V4）。
|
| 偵測情緒 [已棄用] |
此動作已被取代。 請改用情緒 （V4）。
|
| 偵測情緒 （V2） [已淘汰] |
此動作已被取代。 請改用情緒 （V4）。
|
| 偵測語言 [已棄用] |
此動作已被取代。 請改用偵測語言 （V4）。
|
| 偵測語言 [已棄用] |
此動作已被取代。 請改用偵測語言 （V4）。
|
| 偵測語言 （V2） [已淘汰] |
此動作已被取代。 請改用偵測語言 （V4）。
|
| 偵測語言 （V3.1） （預覽版） |
API 會傳回偵測到的語言，以及介於 0 到 1 之間的數值分數。 分數接近 1 表示 100% 確定所識別語言為真的。 如需支援的語言清單，請參閱 語言偵測的語言支援 。 |
| 偵測語言 （V4） （預覽版） |
API 會傳回偵測到的語言，以及介於 0 到 1 之間的數值分數。 分數接近 1 表示 100% 確定所識別語言為真的。 如需支援的語言清單，請參閱 語言偵測的語言支援 。 |
| 具名實體辨識 （V3.0） |
API 會傳回指定文件中一般具名實體的清單。 如需支援的實體類型清單，請勾選 支援的具名實體辨識 （NER） 實體類別。 |
| 具名實體辨識 （V3.1） （預覽版） |
API 會傳回指定文件中一般具名實體的清單。 如需支援的實體類型清單，請勾選 支援的具名實體辨識 （NER） 實體類別。 |
| 具名實體辨識 （V4） （預覽版） |
API 會傳回指定文件中一般具名實體的清單。 如需支援的實體類型清單，請勾選 支援的具名實體辨識 （NER） 實體類別。 |
| 實體 [已棄用] |
此動作已被取代。 請改用具名實體辨識 （V4）。
|
| 實體連結 （V3.0） |
API 會傳回已辨識實體的清單，其中包含已知知識庫的連結。 請參閱 語言支援 ，以取得支援的語言清單。 |
| 實體連結 （v3.1） （預覽版） |
API 會傳回已辨識實體的清單，其中包含已知知識庫的連結。 請參閱 語言支援 ，以取得支援的語言清單。 |
| 實體連結 （V4） （預覽版） |
API 會傳回已辨識實體的清單，其中包含已知知識庫的連結。 請參閱 語言支援 ，以取得支援的語言清單。 |
| 對話 （CLU） （2022-05-01） |
分析輸入交談語句。 |
| 對話 （協調） （2022-05-01） |
分析輸入交談語句。 |
| 從專案產生答案 |
此動作有助於使用專案中的知識庫來回答指定的問題。 |
| 情緒 （V3.0） |
API 會傳回情緒預測，以及文件及其中每個句子的每個情緒類別 （正面、負面和中性） 的情緒分數。 如需支援的語言清單，請參閱 情緒分析和意見採礦語言支援 。 |
| 情緒 （V3.1） （預覽版） |
API 會傳回輸入文字的詳細情緒分析。 分析以多個粒度級別完成，從文檔級別開始，一直到句子和關鍵術語（目標和評估）。 |
| 情緒 （V4） （預覽版） |
API 會傳回輸入文字的詳細情緒分析。 分析以多個粒度級別完成，從文檔級別開始，一直到句子和關鍵術語（目標和評估）。 |
| 檢測語言 （V3.0） |
API 會傳回偵測到的語言，以及介於 0 到 1 之間的數值分數。 分數接近 1 表示 100% 確定所識別語言為真的。 如需支援的語言清單，請參閱 語言偵測的語言支援 。 |
| 異步醫療保健 （2022-05-01） |
提交一系列文本文件以進行醫療保健分析。 |
| 關鍵詞組 [已棄用] |
此動作已被取代。 請改用關鍵詞組 （V4）。
|
| 關鍵詞組 [已棄用] |
此動作已被取代。 請改用關鍵詞組 （V4）。
|
| 關鍵詞組 （V2） [已棄用] |
此動作已被取代。 請改用關鍵詞組 （V4）。
|
| 關鍵詞組 （V3.0） |
API 會傳回字串清單，表示輸入文字中的關鍵片語。 如需支援的語言清單，請參閱 關鍵片語擷取的語言支援 。 |
| 關鍵詞組 （v3.1） （預覽版） |
API 會傳回字串清單，表示輸入文字中的關鍵片語。 如需支援的語言清單，請參閱 關鍵片語擷取的語言支援 。 |
| 關鍵詞組 （v4） （預覽版） |
API 會傳回字串清單，表示輸入文字中的關鍵片語。 如需支援的語言清單，請參閱 關鍵片語擷取的語言支援 。 |
|
非同步 Pii |
提交文本文檔集合以進行個人實體識別分析。 |
| 非同步交談 PII （文字記錄） （2022-05-15-preview） |
提交對話集合以供分析。 指定要執行的一或多個唯一任務。 |
| 非同步交談 PII （文字） （2022-05-15-preview） |
提交對話集合以供分析。 指定要執行的一或多個唯一任務。 |
| 非同步交談摘要 （2022-05-15-preview） |
提交對話集合以供分析。 指定要執行的一或多個唯一任務。 |
| 非同步實體辨識 （2022-05-01） |
提交文字文件集合以進行實體辨識分析。 |
| 非同步實體連結 （2022-05-01） |
提交文字文件集合以進行實體連結分析。 |
| 非同步情緒分析 （2022-05-01） |
提交文本文檔集合以進行情感分析。 |
| 非同步抽象摘要 （2022-10-01-preview） |
提交文字文件集合以進行抽象摘要 |
| 非同步擷取摘要 （2022-10-01-preview） |
提交文字文件集合以進行擷取摘要 |
|
非同步自訂 Single |
提交文字文件集合以進行自訂單一分類分析。 |
| 非同步自訂多標籤分類 （2022-05-01） |
提交文字文件集合以進行自訂單一分類分析。 |
| 非同步自訂實體辨識 （2022-05-01） |
提交文字文件集合以進行自訂實體辨識分析。 |
| 非同步關鍵詞組 （2022-05-01） |
提交文本文檔集合以進行關鍵短語提取分析。 |
偵測個人資訊 （V3.1）
API 會傳回文件中包含個人資訊 （「SSN」、「銀行帳戶」等） 的實體清單。 如需支援的實體類型清單，請檢查支援的 個人識別資訊 （PII） 實體類別。 如需支援的語言清單，請參閱適用於 語言的 Azure 認知服務中支援的語言 。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
網域
|
domain | string |
（選擇性） 如果指定，則會將 PII 網域設定為僅包含實體類別的子集。 可能的值包括：「PHI」、「無」。 |
|
|
stringIndexType
|
stringIndexType | string |
（選用）指定用來解譯字串位移的方法。 根據 Unicode v8.0.0，預設為 Text Elements （Graphemes）。 如需其他資訊，請參閱 https://aka.ms/text-analytics-offsets |
|
|
pii類別
|
piiCategories | array |
（選擇性） 描述要傳回的 PII 類別 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
- 身體
- PiiResult
偵測個人資訊 （V4） （預覽版）
API 會傳回文件中包含個人資訊 （「SSN」、「銀行帳戶」等） 的實體清單。 如需支援的實體類型清單，請檢查支援的 個人識別資訊 （PII） 實體類別。 如需支援的語言清單，請參閱適用於 語言的 Azure 認知服務中支援的語言 。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
資源子網域或區域
|
subdomain | True | string |
Azure 子網域或地理區域 （例如 westus） |
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
網域
|
domain | string |
（選擇性） 如果指定，則會將 PII 網域設定為僅包含實體類別的子集。 可能的值包括：「PHI」、「無」。 |
|
|
stringIndexType
|
stringIndexType | string |
（選用）指定用來解譯字串位移的方法。 根據 Unicode v8.0.0，預設為 Text Elements （Graphemes）。 如需其他資訊，請參閱 https://aka.ms/text-analytics-offsets |
|
|
pii類別
|
piiCategories | array |
（選擇性） 描述要傳回的 PII 類別 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
- 身體
- PiiResult
偵測實體 （V2） [已淘汰]
此動作已被取代。 請改用具名實體辨識 （V4）。
傳回指定文件中已知實體和一般具名實體 （「人員」、「位置」、「組織」等） 的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
唯一的非空白文件識別碼。 |
|
文字
|
text | True | string |
要分析的文字。 |
|
語言
|
language | string |
這是語言的 2 個字母 ISO 639-1 表示。 例如，使用“en”表示英語;“es”代表西班牙語等， |
傳回
偵測情緒 [已棄用]
此動作已被取代。 請改用情緒 （V4）。
傳回介於 0 和 1 之間的數值分數。 分數接近 1 時，表示正面情感；分數接近 0 時，則表示負面情感。 目前支持以下語言：英語、西班牙語、法語、葡萄牙語。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文字
|
text | string |
要分析的文字。 |
|
|
語言
|
language | string |
這是語言的 2 個字母 ISO 639-1 表示。 例如，使用“en”表示英語;“es”代表西班牙語等， |
傳回
偵測情緒 [已棄用]
此動作已被取代。 請改用情緒 （V4）。
傳回介於 0 和 1 之間的數值分數。 分數接近 1 時，表示正面情感；分數接近 0 時，則表示負面情感。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文字
|
text | string |
要分析的文字。 |
|
|
語言
|
language | string |
這是語言的 2 個字母 ISO 639-1 表示。 例如，使用“en”表示英語;“es”代表西班牙語等， |
傳回
偵測情緒 （V2） [已淘汰]
此動作已被取代。 請改用情緒 （V4）。
針對每個文件傳回介於 0 到 1 之間的數值分數。 分數接近 1 時，表示正面情感；分數接近 0 時，則表示負面情感。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
唯一的非空白文件識別碼。 |
|
文字
|
text | True | string |
要分析的文字。 |
|
語言
|
language | string |
這是語言的 2 個字母 ISO 639-1 表示。 例如，使用“en”表示英語;“es”代表西班牙語等， |
傳回
偵測語言 [已棄用]
此動作已被取代。 請改用偵測語言 （V4）。
傳回偵測到的語言和介於 0 和 1 之間的數值分數。 分數接近 1 表示 100% 確定所識別語言為真的。 總共支援 120 種語言。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文字
|
text | string |
要分析的文字。 |
|
|
語言數量
|
numberOfLanguagesToDetect | integer |
要偵測的語言數目。 預設設定為 1。 |
傳回
偵測語言 [已棄用]
此動作已被取代。 請改用偵測語言 （V4）。
傳回偵測到的語言和介於 0 和 1 之間的數值分數。 分數接近 1 表示 100% 確定所識別語言為真的。 總共支援 120 種語言。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文字
|
text | string |
要分析的文字。 |
傳回
偵測語言 （V2） [已淘汰]
此動作已被取代。 請改用偵測語言 （V4）。
傳回偵測到的語言，以及每個文件介於 0 到 1 之間的數值分數。 分數接近 1 表示 100% 確定所識別語言為真的。 總共支援 120 種語言。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
唯一的非空白文件識別碼。 |
|
文字
|
text | True | string |
要分析的文字。 |
傳回
偵測語言 （V3.1） （預覽版）
API 會傳回偵測到的語言，以及介於 0 到 1 之間的數值分數。 分數接近 1 表示 100% 確定所識別語言為真的。 如需支援的語言清單，請參閱 語言偵測的語言支援 。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string | |
|
國家提示
|
countryHint | string |
傳回
偵測語言 （V4） （預覽版）
API 會傳回偵測到的語言，以及介於 0 到 1 之間的數值分數。 分數接近 1 表示 100% 確定所識別語言為真的。 如需支援的語言清單，請參閱 語言偵測的語言支援 。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
資源子網域或區域
|
subdomain | True | string |
Azure 子網域或地理區域 （例如 westus） |
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string | |
|
國家提示
|
countryHint | string |
傳回
具名實體辨識 （V3.0）
API 會傳回指定文件中一般具名實體的清單。 如需支援的實體類型清單，請勾選 支援的具名實體辨識 （NER） 實體類別。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計數據
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含輸入和文件層級統計資料。 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
具名實體辨識 （V3.1） （預覽版）
API 會傳回指定文件中一般具名實體的清單。 如需支援的實體類型清單，請勾選 支援的具名實體辨識 （NER） 實體類別。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
stringIndexType
|
stringIndexType | string |
（選用）指定用來解譯字串位移的方法。 根據 Unicode v8.0.0，預設為 Text Elements （Graphemes）。 如需其他資訊，請參閱 https://aka.ms/text-analytics-offsets |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
具名實體辨識 （V4） （預覽版）
API 會傳回指定文件中一般具名實體的清單。 如需支援的實體類型清單，請勾選 支援的具名實體辨識 （NER） 實體類別。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
資源子網域或區域
|
subdomain | True | string |
Azure 子網域或地理區域 （例如 westus） |
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
stringIndexType
|
stringIndexType | string |
（選用）指定用來解譯字串位移的方法。 根據 Unicode v8.0.0，預設為 Text Elements （Graphemes）。 如需其他資訊，請參閱 https://aka.ms/text-analytics-offsets |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
實體 [已棄用]
此動作已被取代。 請改用具名實體辨識 （V4）。
傳回指定文件中已知實體和一般具名實體 （「人員」、「位置」、「組織」等） 的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文字
|
text | string |
要分析的文字。 |
|
|
語言
|
language | string |
這是語言的 2 個字母 ISO 639-1 表示。 例如，使用“en”表示英語;“es”代表西班牙語等， |
傳回
實體連結 （V3.0）
API 會傳回已辨識實體的清單，其中包含已知知識庫的連結。 請參閱 語言支援 ，以取得支援的語言清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計數據
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含輸入和文件層級統計資料。 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
實體連結 （v3.1） （預覽版）
API 會傳回已辨識實體的清單，其中包含已知知識庫的連結。 請參閱 語言支援 ，以取得支援的語言清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
stringIndexType
|
stringIndexType | string |
（選用）指定用來解譯字串位移的方法。 根據 Unicode v8.0.0，預設為 Text Elements （Graphemes）。 如需其他資訊，請參閱 https://aka.ms/text-analytics-offsets |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
實體連結 （V4） （預覽版）
API 會傳回已辨識實體的清單，其中包含已知知識庫的連結。 請參閱 語言支援 ，以取得支援的語言清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
資源子網域或區域
|
subdomain | True | string |
Azure 子網域或地理區域 （例如 westus） |
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
stringIndexType
|
stringIndexType | string |
（選用）指定用來解譯字串位移的方法。 根據 Unicode v8.0.0，預設為 Text Elements （Graphemes）。 如需其他資訊，請參閱 https://aka.ms/text-analytics-offsets |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
對話 （CLU） （2022-05-01）
分析輸入交談語句。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
語言
|
language | string |
BCP 47 語言表示法中的交談專案覆寫語言。 |
|
|
收發簡訊
|
text | True | string |
文字輸入 |
|
projectName
|
projectName | True | string |
要使用的項目名稱。 |
|
deploymentName
|
deploymentName | True | string |
要使用的部署名稱。 |
|
詳細資訊
|
verbose | boolean |
如果為 true，服務會在回應中傳回更詳細的資訊。 |
傳回
交談工作的結果。
對話 （協調） （2022-05-01）
分析輸入交談語句。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
語言
|
language | string |
BCP 47 語言表示法中的交談專案覆寫語言。 |
|
|
收發簡訊
|
text | True | string |
文字輸入 |
|
projectName
|
projectName | True | string |
要使用的項目名稱。 |
|
deploymentName
|
deploymentName | True | string |
要使用的部署名稱。 |
|
詳細資訊
|
verbose | boolean |
如果為 true，服務會在回應中傳回更詳細的資訊。 |
|
|
直接目標
|
directTarget | string |
要轉送要求的目標項目名稱。 |
|
|
targetProject參數
|
targetProjectParameters | object |
字典，代表每個目標項目的參數。 |
傳回
交談工作的結果。
從專案產生答案
此動作有助於使用專案中的知識庫來回答指定的問題。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案名稱
|
projectName | True | string |
這是您要使用的專案名稱。 |
|
Question
|
question | string |
針對專案查詢的使用者問題。 |
|
|
使用者識別碼
|
userId | string |
用戶的唯一識別碼。 |
|
|
頂#
|
top | integer |
要針對問題傳回的答案數目上限。 |
|
|
信賴度臨界值
|
confidenceScoreThreshold | float |
答案的最低閾值分數。 值範圍從 0 到 1。 |
|
|
排名器類型
|
rankerType | string |
要使用的排名器類型。 |
|
|
QnA 識別碼
|
qnaId | string |
這是要從專案擷取的確切 QnA 識別碼。 |
|
|
先前的 QnA 識別碼
|
previousQnaId | integer |
上一個回合最上層答案結果 QnA 識別碼。 |
|
|
上一個用戶查詢
|
previousUserQuery | string |
先前的用戶查詢。 |
|
|
Key
|
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 版本。 |
傳回
代表問題解答清單。
情緒 （V3.0）
API 會傳回情緒預測，以及文件及其中每個句子的每個情緒類別 （正面、負面和中性） 的情緒分數。 如需支援的語言清單，請參閱 情緒分析和意見採礦語言支援 。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計數據
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含輸入和文件層級統計資料。 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
情緒 （V3.1） （預覽版）
API 會傳回輸入文字的詳細情緒分析。 分析以多個粒度級別完成，從文檔級別開始，一直到句子和關鍵術語（目標和評估）。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
意見挖礦
|
opinionMining | boolean |
（選擇性） 如果設定為 true，回應不僅會包含情緒預測，還會包含意見探勘 （以相位為基礎的情緒分析） 結果。 |
|
|
stringIndexType
|
stringIndexType | string |
（選用）指定用來解譯字串位移的方法。 根據 Unicode v8.0.0，預設為 Text Elements （Graphemes）。 如需其他資訊，請參閱 https://aka.ms/text-analytics-offsets |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
情緒 （V4） （預覽版）
API 會傳回輸入文字的詳細情緒分析。 分析以多個粒度級別完成，從文檔級別開始，一直到句子和關鍵術語（目標和評估）。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
資源子網域或區域
|
subdomain | True | string |
Azure 子網域或地理區域 （例如 westus） |
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
意見挖礦
|
opinionMining | boolean |
（選擇性） 如果設定為 true，回應不僅會包含情緒預測，還會包含意見探勘 （以相位為基礎的情緒分析） 結果。 |
|
|
stringIndexType
|
stringIndexType | string |
（選用）指定用來解譯字串位移的方法。 根據 Unicode v8.0.0，預設為 Text Elements （Graphemes）。 如需其他資訊，請參閱 https://aka.ms/text-analytics-offsets |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
檢測語言 （V3.0）
API 會傳回偵測到的語言，以及介於 0 到 1 之間的數值分數。 分數接近 1 表示 100% 確定所識別語言為真的。 如需支援的語言清單，請參閱 語言偵測的語言支援 。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計數據
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含輸入和文件層級統計資料。 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string | |
|
國家提示
|
countryHint | string |
傳回
異步醫療保健 （2022-05-01）
提交一系列文本文件以進行醫療保健分析。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
關鍵詞組 [已棄用]
此動作已被取代。 請改用關鍵詞組 （V4）。
傳回字串清單，表示輸入文字中的關鍵談話要點。 目前支援以下語言：英語、德語、西班牙語和日語。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文字
|
text | string |
要分析的文字。 |
|
|
語言
|
language | string |
這是語言的 2 個字母 ISO 639-1 表示。 例如，使用“en”表示英語;“es”代表西班牙語等， |
傳回
關鍵詞組 [已棄用]
此動作已被取代。 請改用關鍵詞組 （V4）。
傳回字串清單，表示輸入文字中的關鍵談話要點。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文字
|
text | string |
要分析的文字。 |
|
|
語言
|
language | string |
這是語言的 2 個字母 ISO 639-1 表示。 例如，使用“en”表示英語;“es”代表西班牙語等， |
傳回
關鍵詞組 （V2） [已棄用]
此動作已被取代。 請改用關鍵詞組 （V4）。
傳回字串清單，表示每個文件輸入文字中的關鍵談話要點。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
唯一的非空白文件識別碼。 |
|
文字
|
text | True | string |
要分析的文字。 |
|
語言
|
language | string |
這是語言的 2 個字母 ISO 639-1 表示。 例如，使用“en”表示英語;“es”代表西班牙語等， |
傳回
關鍵詞組 （V3.0）
API 會傳回字串清單，表示輸入文字中的關鍵片語。 如需支援的語言清單，請參閱 關鍵片語擷取的語言支援 。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計數據
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含輸入和文件層級統計資料。 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
關鍵詞組 （v3.1） （預覽版）
API 會傳回字串清單，表示輸入文字中的關鍵片語。 如需支援的語言清單，請參閱 關鍵片語擷取的語言支援 。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
關鍵詞組 （v4） （預覽版）
API 會傳回字串清單，表示輸入文字中的關鍵片語。 如需支援的語言清單，請參閱 關鍵片語擷取的語言支援 。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
資源子網域或區域
|
subdomain | True | string |
Azure 子網域或地理區域 （例如 westus） |
|
型號版本
|
model-version | string |
（選用）此值指出將用於評分的模型。 如果未指定模型版本，API 應該預設為最新的非預覽版本。 |
|
|
顯示統計
|
showStats | boolean |
（選擇性） 如果設定為 true，回應將包含要求和文件層級統計資料。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
（選用）如果設定為 true，您可以選擇不記錄文字輸入以進行疑難排解。 根據預設，適用於語言的 Azure 認知服務會記錄您的輸入文字 48 小時，只是為了針對為您提供適用於語言的 Azure 認知服務自然語言處理函式進行疑難排解。 將此參數設定為 true，會停用輸入記錄，並可能限制我們補救發生問題的能力。 如需其他詳細資料，請參閱 認知服務合規性和隱私權附註， https://aka.ms/cs-compliance 以及 的 Microsoft 負責任 AI 原則 https://www.microsoft.com/en-us/ai/responsible-ai。 |
|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
非同步 PiiEntityRecognition （2022-05-01）
提交文本文檔集合以進行個人實體識別分析。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
|
|
網域
|
domain | string |
用於 PII 實體辨識的 PII 網域。 |
|
|
pii類別
|
piiCategories | array of string |
（選擇性） 描述要傳回的 PII 類別 |
傳回
非同步交談 PII （文字記錄） （2022-05-15-preview）
提交對話集合以供分析。 指定要執行的一或多個唯一任務。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
交談專案的標識碼。 |
|
participantId
|
participantId | True | string |
交談項目的參與者標識碼。 |
|
語言
|
language | string |
BCP 47 語言表示法中的交談專案覆寫語言。 |
|
|
角色
|
role | string |
參與者的角色。 |
|
|
ITN
|
itn | string |
輸入的逆文本正規化表示。 反向文字正規化形式是從 Microsoft 的語音轉文字 API 中辨識的文字，並套用電話號碼、數字、縮寫和其他轉換。 |
|
|
蒙面Itn
|
maskedItn | string |
套用褻瀆遮罩的反向文字正規化格式。 |
|
|
收發簡訊
|
text | string |
從語音到文字 API 的已辨識文字的顯示形式，並新增標點符號和大寫。 |
|
|
詞彙
|
lexical | string |
從語音到文本 API 的已識別文本的詞彙形式，具有識別的實際單詞。 |
|
|
字組
|
word | string |
這個詞被認可了。 |
|
|
位移
|
offset | integer |
從語音音訊開頭的偏移量，以刻度為單位。 1 刻 = 100 納秒。 |
|
|
duration
|
duration | integer |
單詞發音的持續時間，以滴答聲為單位。 1 刻 = 100 納秒。 |
|
|
語言
|
language | True | string |
BCP-47 格式的交談項目語言。 |
|
網域
|
domain | string |
列舉支援的交談網域。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean | ||
|
pii類別
|
piiCategories | array of string |
描述要傳回進行偵測的 PII 類別。 如果未提供，則會傳回「預設」類別，該類別會因語言而異。 |
|
|
includeAudio編輯
|
includeAudioRedaction | boolean |
旗標，指出是否要求音訊編輯。 預設情況下，不會執行音訊編輯。 |
|
|
編輯來源
|
redactionSource | string |
列舉支援的文字記錄內容類型。 |
傳回
包含已提交的分析交談作業的狀態以及相關統計資料。
非同步交談 PII （文字） （2022-05-15-preview）
提交對話集合以供分析。 指定要執行的一或多個唯一任務。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
交談專案的標識碼。 |
|
participantId
|
participantId | True | string |
交談項目的參與者標識碼。 |
|
語言
|
language | string |
BCP 47 語言表示法中的交談專案覆寫語言。 |
|
|
角色
|
role | string |
參與者的角色。 |
|
|
收發簡訊
|
text | True | string |
文字輸入 |
|
語言
|
language | True | string |
BCP-47 格式的交談項目語言。 |
|
網域
|
domain | string |
列舉支援的交談網域。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean | ||
|
pii類別
|
piiCategories | array of string |
描述要傳回進行偵測的 PII 類別。 如果未提供，則會傳回「預設」類別，該類別會因語言而異。 |
傳回
包含已提交的分析交談作業的狀態以及相關統計資料。
非同步交談摘要 （2022-05-15-preview）
提交對話集合以供分析。 指定要執行的一或多個唯一任務。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
交談專案的標識碼。 |
|
participantId
|
participantId | True | string |
交談項目的參與者標識碼。 |
|
語言
|
language | string |
BCP 47 語言表示法中的交談專案覆寫語言。 |
|
|
角色
|
role | string |
參與者的角色。 |
|
|
收發簡訊
|
text | True | string |
文字輸入 |
|
語言
|
language | True | string |
BCP-47 格式的交談項目語言。 |
|
網域
|
domain | string |
列舉支援的交談網域。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean | ||
|
總結方面
|
summaryAspects | True | array of string |
傳回
包含已提交的分析交談作業的狀態以及相關統計資料。
非同步實體辨識 （2022-05-01）
提交文字文件集合以進行實體辨識分析。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
非同步實體連結 （2022-05-01）
提交文字文件集合以進行實體連結分析。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
傳回
非同步情緒分析 （2022-05-01）
提交文本文檔集合以進行情感分析。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
|
|
意見挖礦
|
opinionMining | boolean |
傳回
非同步抽象摘要 （2022-10-01-preview）
提交文字文件集合以進行抽象摘要
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
|
|
句子計數
|
sentenceCount | integer |
它控制輸出摘要中的大致句子數。 |
傳回
非同步擷取摘要 （2022-10-01-preview）
提交文字文件集合以進行擷取摘要
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
|
|
句子計數
|
sentenceCount | integer | ||
|
排序依據
|
sortBy | string |
要用於擷取摘要結果的排序準則。 |
傳回
非同步自訂 SingleLabelClassification （2022-05-01）
提交文字文件集合以進行自訂單一分類分析。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
|
|
projectName
|
projectName | True | string |
此欄位指出模型的專案名稱。 |
|
deploymentName
|
deploymentName | True | string |
此欄位指出模型的部署名稱。 |
傳回
非同步自訂多標籤分類 （2022-05-01）
提交文字文件集合以進行自訂單一分類分析。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
|
|
projectName
|
projectName | True | string |
此欄位指出模型的專案名稱。 |
|
deploymentName
|
deploymentName | True | string |
此欄位指出模型的部署名稱。 |
傳回
非同步自訂實體辨識 （2022-05-01）
提交文字文件集合以進行自訂實體辨識分析。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
|
|
projectName
|
projectName | True | string |
此欄位指出模型的專案名稱。 |
|
deploymentName
|
deploymentName | True | string |
此欄位指出模型的部署名稱。 |
傳回
非同步關鍵詞組 （2022-05-01）
提交文本文檔集合以進行關鍵短語提取分析。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
識別碼
|
id | True | string |
唯一的非空白文件識別碼。 |
|
收發簡訊
|
text | True | string |
要處理的輸入文字。 |
|
語言
|
language | string |
（選用）這是語言的 2 個字母 ISO 639-1 表示。 例如，使用 「en」 表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用 「en」 作為預設值。 |
|
|
記錄選擇退出
|
loggingOptOut | boolean |
傳回
定義
ConversationalPIITranscriptJobState
包含已提交的分析交談作業的狀態以及相關統計資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
顯示名稱
|
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 | ConversationRequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
已完成
|
tasks.completed | integer |
成功完成的任務計數。 |
|
失敗
|
tasks.failed | integer |
失敗的工作計數。 |
|
進行中
|
tasks.inProgress | integer |
目前進行中的任務計數。 |
|
總計
|
tasks.total | integer |
作為工作一部分提交的任務總數。 |
|
任務結果
|
tasks.taskResult | ConversationalPIITranscriptResult |
對對話清單執行的個人識別資訊偵測和編輯作業的結果。 |
交談請求統計資料
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件計數
|
documentsCount | integer |
在請求中提交的文件數量。 |
|
validDocumentsCount
|
validDocumentsCount | integer |
有效文件數量。 這不包括空白、大小限制過大或不支援的語言文件。 |
|
錯誤文件計數
|
erroneousDocumentsCount | integer |
無效文件的數目。 這包括空白、大小限制或不支援的語言文件。 |
|
交易計數
|
transactionsCount | integer |
要求的交易數目。 |
|
conversations計數
|
conversationsCount | integer |
要求中提交的交談數目。 |
|
validConversationsCount
|
validConversationsCount | integer |
交談文件的數目。 這不包括空白、大小限制過大或不支援的語言文件。 |
|
錯誤的對話計數
|
erroneousConversationsCount | integer |
無效文件的數目。 這包括空白、大小限制或不支援的語言文件。 |
ConversationalPIITranscript結果
對對話清單執行的個人識別資訊偵測和編輯作業的結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
lastUpdateDateTime
|
lastUpdateDateTime | date-time |
任務的上次更新時間（UTC）。 |
|
狀態
|
status |
上述上次更新時間的任務狀態。 |
|
|
task名稱
|
taskName | string | |
|
類型
|
kind | ConversationalPIIResultsKind |
列舉支援的交談分析工作結果。 |
|
results
|
results | ConversationPIITranscriptResults |
每個交談的 PII 偵測和編輯作業的結果。 |
對話式PIIResultsKind
列舉支援的交談分析工作結果。
ConversationPIITranscript結果
每個交談的 PII 偵測和編輯作業的結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
conversationItems
|
conversations.conversationItems | array of ConversationPIITranscriptItemResult |
列舉交談中所有交談項目的 PII 偵測和編輯作業結果。 |
|
識別碼
|
conversations.id | string |
唯一的非空白交談識別碼。 |
|
警告
|
conversations.warnings | array of InputWarning |
處理文件時遇到警告。 |
|
統計資料
|
conversations.statistics | ConversationStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關交談承載的資訊。 |
|
錯誤
|
errors | array of InputError |
依文件識別碼的錯誤。 |
|
統計資料
|
statistics | RequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
模型版本
|
modelVersion | string |
此欄位指出用於評分的模型。 |
輸入錯誤
包含工作執行期間遇到的錯誤詳細資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
輸入的 ID。 |
|
錯誤
|
error | Error |
error 物件。 |
輸入警告
包含工作執行期間遇到的警告詳細資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string |
警告代碼。 |
|
訊息
|
message | string |
警告訊息。 |
|
targetRef
|
targetRef | string |
指出目標物件的 JSON 指標參考。 |
對話統計
如果在請求中指定了 showStats=true，則此欄位將包含有關交談承載的資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
交易計數
|
transactionsCount | integer |
要求的文字單位數。 |
ConversationPIITranscriptItem結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string | |
|
已編輯內容
|
redactedContent | ConversationalPIITranscriptRedactedTranscriptContent |
服務產生的文字記錄內容回應，其中包含所有必要的個人識別資訊。 |
|
entities
|
entities | array of Entity |
ConversationalPIITranscriptRedactedTranscript內容
服務產生的文字記錄內容回應，其中包含所有必要的個人識別資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ITN
|
itn | string |
反向文字正規化格式輸入的已編輯輸出。 |
|
蒙面Itn
|
maskedItn | string |
遮罩反向文字正規化格式輸入的編輯輸出。 |
|
收發簡訊
|
text | string |
文字的編輯輸出 （Microsoft 的語音轉文字「顯示」） 格式輸入。 |
|
詞彙
|
lexical | string |
詞法格式輸入的已編輯輸出。 |
|
音訊時序
|
audioTimings | array of AudioTiming |
已編輯的音訊區段清單。 |
音訊計時
音訊計時資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
位移
|
offset | integer |
從語音音訊開頭的偏移量，以刻度為單位。 1 刻 = 100 納秒。 |
|
duration
|
duration | integer |
單詞發音的持續時間，以滴答聲為單位。 1 刻 = 100 納秒。 |
ConversationalPIITextJobState
包含已提交的分析交談作業的狀態以及相關統計資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
顯示名稱
|
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 | ConversationRequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
已完成
|
tasks.completed | integer |
成功完成的任務計數。 |
|
失敗
|
tasks.failed | integer |
失敗的工作計數。 |
|
進行中
|
tasks.inProgress | integer |
目前進行中的任務計數。 |
|
總計
|
tasks.total | integer |
作為工作一部分提交的任務總數。 |
|
任務結果
|
tasks.taskResult | ConversationalPIITextResult |
對對話清單執行的個人識別資訊偵測和編輯作業的結果。 |
對話PIITextResult
對對話清單執行的個人識別資訊偵測和編輯作業的結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
lastUpdateDateTime
|
lastUpdateDateTime | date-time |
任務的上次更新時間（UTC）。 |
|
狀態
|
status |
上述上次更新時間的任務狀態。 |
|
|
task名稱
|
taskName | string | |
|
類型
|
kind | ConversationalPIIResultsKind |
列舉支援的交談分析工作結果。 |
|
results
|
results | ConversationPIITextResults |
每個交談的 PII 偵測和編輯作業的結果。 |
ConversationPIIText結果
每個交談的 PII 偵測和編輯作業的結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
conversationItems
|
conversations.conversationItems | array of ConversationPIITextItemResult |
列舉交談中所有交談項目的 PII 偵測和編輯作業結果。 |
|
識別碼
|
conversations.id | string |
唯一的非空白交談識別碼。 |
|
警告
|
conversations.warnings | array of InputWarning |
處理文件時遇到警告。 |
|
統計資料
|
conversations.statistics | ConversationStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關交談承載的資訊。 |
|
錯誤
|
errors | array of InputError |
依文件識別碼的錯誤。 |
|
統計資料
|
statistics | RequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
模型版本
|
modelVersion | string |
此欄位指出用於評分的模型。 |
交談PIITextItem結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string | |
|
已編輯內容
|
redactedContent | ConversationalPIITranscriptRedactedTextContent |
服務產生的文字記錄內容回應，其中包含所有必要的個人識別資訊。 |
|
entities
|
entities | array of Entity |
ConversationalPIITranscriptRedactedTextContent
服務產生的文字記錄內容回應，其中包含所有必要的個人識別資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收發簡訊
|
text | string |
文字的編輯輸出 （Microsoft 的語音轉文字「顯示」） 格式輸入。 |
分析對話摘要JobState
包含已提交的分析交談作業的狀態以及相關統計資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
顯示名稱
|
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 | ConversationRequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
已完成
|
tasks.completed | integer |
成功完成的任務計數。 |
|
失敗
|
tasks.failed | integer |
失敗的工作計數。 |
|
進行中
|
tasks.inProgress | integer |
目前進行中的任務計數。 |
|
總計
|
tasks.total | integer |
作為工作一部分提交的任務總數。 |
|
任務結果
|
tasks.taskResult | AnalyzeConversationSummarizationResult |
交談上摘要工作的結果。 |
AnalyzeConversationSummarizationResult
交談上摘要工作的結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
lastUpdateDateTime
|
lastUpdateDateTime | date-time |
任務的上次更新時間（UTC）。 |
|
狀態
|
status |
上述上次更新時間的任務狀態。 |
|
|
task名稱
|
taskName | string | |
|
類型
|
kind | ConversationalSummarizationResultsKind |
列舉支援的交談分析工作結果。 |
|
results
|
results | SummaryResult |
交談摘要結果種類
列舉支援的交談分析工作結果。
摘要結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
summaries
|
conversations.summaries | array of SummaryResultItem | |
|
識別碼
|
conversations.id | string |
唯一的非空白交談識別碼。 |
|
警告
|
conversations.warnings | array of InputWarning |
處理文件時遇到警告。 |
|
統計資料
|
conversations.statistics | ConversationStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關交談承載的資訊。 |
|
錯誤
|
errors | array of InputError |
依文件識別碼的錯誤。 |
|
統計資料
|
statistics | RequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
模型版本
|
modelVersion | string |
此欄位指出用於評分的模型。 |
摘要結果項目
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
方面
|
aspect | string | |
|
收發簡訊
|
text | string |
錯誤
error 物件。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | ErrorCode |
人類可讀取的錯誤碼。 |
|
訊息
|
message | string |
錯誤的人類可讀取表示法。 |
|
目標
|
target | string |
錯誤的目標。 |
|
details
|
details | array of Error |
導致此錯誤之特定錯誤的詳細數據陣列。 |
|
inner錯誤
|
innererror | InnerErrorModel |
物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
ErrorCode
內部錯誤模型
物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | InnerErrorCode |
人類可讀取的錯誤碼。 |
|
訊息
|
message | string |
錯誤訊息。 |
|
details
|
details | object |
錯誤詳細數據。 |
|
目標
|
target | string |
錯誤目標。 |
|
inner錯誤
|
innererror | InnerErrorModel |
物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
內部錯誤代碼
LanguageCustomEntities結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of LanguageEntitiesDocumentResult |
按文件回應 |
LanguageCustomLabelClassificationResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of LanguageClassificationDocumentResult |
按文件回應 |
語言分類結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
分類
|
category | string |
分類類型。 |
|
confidenceScore
|
confidenceScore | double |
認可類別的置信度分數介於 0 到 1 之間。 |
語言分類文件結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類別
|
class | array of LanguageClassificationResult | |
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
語言醫療保健結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of LanguageHealthcareEntitiesDocumentResult |
語言HealthcareEntitiesDocumentResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
entities
|
entities | array of LanguageHealthcareEntity |
醫療保健實體。 |
|
relations
|
relations | array of LanguageHealthcareRelation |
醫療保健實體關係。 |
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
語言醫療保健實體
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收發簡訊
|
text | string |
請求中顯示的實體文字。 |
|
分類
|
category | string |
醫療保健實體類別。 |
|
子類別
|
subcategory | string |
（選用）實體子類型。 |
|
位移
|
offset | integer |
實體文字的起始位置。 使用不同的 'stringIndexType' 值可能會影響傳回的位移量。 |
|
length
|
length | integer |
實體文字的長度。 使用不同的 'stringIndexType' 值可能會影響傳回的長度。 |
|
confidenceScore
|
confidenceScore | double |
擷取實體的信賴度分數介於 0 到 1 之間。 |
|
判斷提示
|
assertion | LanguageHealthcareAssertion | |
|
名稱
|
name | string |
實體的偏好名稱。 示例：“組織學上”的“名稱”為“組織學”。 |
|
links
|
links | array of LanguageHealthcareEntityLink |
已知資料來源中的實體參照。 |
語言醫療保健關係
每個關係都是特定 relationType 的實體圖，其中所有實體都是連接的，並且在關係上下文中具有特定的角色。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
關係類型
|
relationType | string |
關係類型。 例子包括： |
|
entities
|
entities | array of LanguageHealthcareRelationEntity |
關聯中的實體。 |
語言醫療保健斷言
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
條件性
|
conditionality | string |
描述實體上的任何條件。 |
|
確定性
|
certainty | string |
描述實體確定性和極性。 |
|
關聯
|
association | string |
描述實體是文字的主旨，還是描述其他人。 |
語言HealthcareRelationEntity
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ref
|
ref | string |
參考連結物件，使用 JSON 指標 RFC 6901 （URI 片段識別碼表示），指向實體。 |
|
角色
|
role | string |
實體在關係中的角色。 例如：「CD20陽性瀰漫性大B細胞淋巴瘤」有以下實體，括號內有其作用：CD20（基因或蛋白質）、陽性（表達）、瀰漫性大B細胞淋巴瘤（診斷）。 |
語言醫療保健實體連結
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
dataSource
|
dataSource | string |
實體目錄。 範例包括：UMLS、CHV、MSH 等。 |
|
識別碼
|
id | string |
指定來源目錄中的實體識別碼。 |
語言SentimentResponse
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of LanguageSentimentDocumentResult |
每個文件的情緒分析。 |
LanguageSentimentDocument結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
人氣
|
sentiment | string |
文件的預測情緒 （負面、中性、正面或混合）。 |
|
confidenceScores
|
confidenceScores | LanguageSentimentConfidenceScorePerLabel |
代表所有情緒類別介於 0 到 1 之間的信賴度分數：正面、中性、負面。 |
|
句子
|
sentences | array of LanguageSentenceSentiment |
句子級情感分析。 |
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
LanguageSentimentConfidenceScorePerLabel
代表所有情緒類別介於 0 到 1 之間的信賴度分數：正面、中性、負面。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
陽性
|
positive | double |
正面情緒的置信度分數 |
|
中性
|
neutral | double |
中性情緒的置信度分數 |
|
陰性
|
negative | double |
負面情緒的信賴度分數 |
語言SentenceSentiment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收發簡訊
|
text | string |
句子文本。 |
|
人氣
|
sentiment | string |
預測的句子情緒。 |
|
confidenceScores
|
confidenceScores | LanguageSentimentConfidenceScorePerLabel |
代表所有情緒類別介於 0 到 1 之間的信賴度分數：正面、中性、負面。 |
|
位移
|
offset | integer |
從文件開頭偏移的句子。 |
|
length
|
length | integer |
刑期的長度。 |
|
targets
|
targets | array of LanguageSentenceTarget |
句子的句子目標陣列。 |
|
評量
|
assessments | array of LanguageSentenceAssessment |
句子的一系列評估。 |
語言句子目標
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
人氣
|
sentiment | string |
句子中有針對性的情緒。 |
|
confidenceScores
|
confidenceScores | LanguageTargetConfidenceScoreLabel |
代表所有情緒類別的信賴度分數：正面和負面。 |
|
位移
|
offset | integer |
從句子開頭開始的目標偏移。 |
|
length
|
length | integer |
目標的長度。 |
|
收發簡訊
|
text | string |
偵測到的目標文字。 |
|
relations
|
relations | array of LanguageTargetRelation |
與目標相關的評量或目標物件陣列。 |
語言句子評估
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
人氣
|
sentiment | string |
句子中的評估情緒。 |
|
confidenceScores
|
confidenceScores | LanguageTargetConfidenceScoreLabel |
代表所有情緒類別的信賴度分數：正面和負面。 |
|
位移
|
offset | integer |
評估從句子的開頭開始抵消。 |
|
length
|
length | integer |
評估的長度。 |
|
收發簡訊
|
text | string |
偵測到的評量文字。 |
|
是否定的
|
isNegated | boolean |
表示評量是否被否定的指標。 |
語言目標關係
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
關係類型
|
relationType | string |
與目標相關的類型。 |
|
ref
|
ref | string |
指出連結物件的 JSON 指標。 |
語言目標置信度分數標籤
代表所有情緒類別的信賴度分數：正面和負面。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
陽性
|
positive | double |
正面情緒的置信度分數 |
|
陰性
|
negative | double |
負面情緒的信賴度分數 |
LanguageEntities結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of LanguageEntitiesDocumentResult |
按文件回應 |
語言實體文件結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
entities
|
entities | array of LanguageEntity |
文件中已辨識的實體。 |
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
語言實體
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收發簡訊
|
text | string |
請求中顯示的實體文字。 |
|
分類
|
category | string |
實體類型。 |
|
子類別
|
subcategory | string |
（選用）實體子類型。 |
|
位移
|
offset | integer |
實體文字的起始位置。 使用不同的 'stringIndexType' 值可能會影響傳回的位移量。 |
|
length
|
length | integer |
實體文字的長度。 使用不同的 'stringIndexType' 值可能會影響傳回的長度。 |
|
confidenceScore
|
confidenceScore | double |
擷取實體的信賴度分數介於 0 到 1 之間。 |
LanguageEntityLinking結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of LanguageLinkedEntitiesDocumentResult |
按文件回應 |
LanguageLinkedEntitiesDocument結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
entities
|
entities | array of LanguageLinkedEntity |
文件中識別的眾所周知的實體。 |
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
語言連結實體
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
實體連結正式名稱。 |
|
比賽
|
matches | array of LanguageMatch |
此實體出現在文字中的實例清單。 |
|
語言
|
language | string |
資料來源中使用的語言。 |
|
識別碼
|
id | string |
資料來源中已辨識實體的唯一識別碼。 |
|
url
|
url | string |
資料來源中實體頁面的 URL。 |
|
dataSource
|
dataSource | string |
用於提取實體鏈接的數據源，例如 Wiki/Bing 等。 |
|
bingId
|
bingId | string |
已辨識實體的 Bing 實體搜尋 API 唯一識別碼。 |
語言匹配
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
confidenceScore
|
confidenceScore | double |
如果辨識出已知項目，則會傳回表示 0 到 1 之間的信賴水準的十進位數。 |
|
收發簡訊
|
text | string |
請求中顯示的實體文字。 |
|
位移
|
offset | integer |
實體相符文字的起始位置。 |
|
length
|
length | integer |
實體相符文字的長度。 |
語言Pii結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of LanguagePiiEntitiesDocumentResult |
按文件回應 |
LanguagePiiEntitiesDocument結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
已編輯文本
|
redactedText | string |
傳回已編輯的文字。 |
|
entities
|
entities | array of LanguageEntity |
文件中已辨識的實體。 |
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
LanguageKeyPhrase結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of LanguageKeyPhrasesDocumentResult |
按文件回應 |
LanguageKeyPhrasesDocument結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
關鍵詞組
|
keyPhrases | array of string |
代表性單字或片語的清單。 傳回的關鍵片語數目與輸入文件中的字數成正比。 |
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
LanguageAnalyzeTextJobState_KPE
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | LanguageKeyPhraseExtractionLROResult |
LanguageAnalyzeTextJobState_CNER
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | LanguageCustomEntityRecognitionLROResult |
LanguageAnalyzeTextJobState_CSLC
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | LanguageCustomSingleLabelClassificationLROResult |
LanguageAnalyzeTextJobState_CMLC
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | LanguageCustomMultiLabelClassificationLROResult |
LanguageAnalyzeTextJobState_Entites
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | LanguageEntityRecognitionLROResult |
LanguageAnalyzeTextJobState_Pii
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | LanguagePiiEntityRecognitionLROResult |
LanguageAnalyzeTextJobState_Sentiment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | LanguageSentimentLROResult |
LanguageAnalyzeTextJobState_HealthCare
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | LanguageHealthcareLROResult |
LanguageAnalyzeTextJobState_ExtractiveSummarization
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | ExtractiveSummarizationLROResult |
LanguageAnalyzeTextJobState_AbstractiveSummarization
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | AbstractiveSummarizationLROResult |
代表抽象摘要工作結果的物件。 |
LanguageAnalyzeTextJobState_EntityLinking
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
任務結果
|
tasks.taskResult | LanguageEntityLinkingLROResult |
LanguageEntityRecognitionLROResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | LanguageEntitiesResult |
LanguageCustomEntityRecognitionLROResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | LanguageCustomEntitiesResult |
語言自訂單一標籤分類LROResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | LanguageCustomLabelClassificationResult |
LanguageCustomMultiLabelClassificationLROResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | LanguageCustomLabelClassificationResult |
LanguageEntityLinkingLROResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | LanguageEntityLinkingResult |
LanguagePiiEntityRecognitionLROResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | LanguagePiiResult |
語言醫療保健LROResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | LanguageHealthcareResult |
LanguageSentimentLROResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | LanguageSentimentResponse |
LanguageKeyPhraseExtractionLROResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | LanguageKeyPhraseResult |
語言文件警告
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string |
錯誤碼。 |
|
訊息
|
message | string |
警告訊息。 |
|
targetRef
|
targetRef | string |
指出目標物件的 JSON 指標參考。 |
文件錯誤
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
文件 ID。 |
|
錯誤
|
error | TextAnalyticsError |
TextAnalytics錯誤
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string |
錯誤碼。 |
|
訊息
|
message | string |
錯誤訊息。 |
|
目標
|
target | string |
錯誤目標。 |
|
inner錯誤
|
innererror | InnerError | |
|
details
|
details | array of TextAnalyticsError |
導致此報告錯誤的特定錯誤的詳細資訊。 |
TextAnalytics警告
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string |
錯誤碼。 |
|
訊息
|
message | string |
警告訊息。 |
|
targetRef
|
targetRef | string |
指出目標物件的 JSON 指標參考。 |
InnerError
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string |
錯誤碼。 |
|
訊息
|
message | string |
錯誤訊息。 |
|
details
|
details | object |
錯誤詳細數據。 |
|
目標
|
target | string |
錯誤目標。 |
|
inner錯誤
|
innererror | InnerError |
情緒回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of DocumentSentiment |
每個文件的情緒分析。 |
|
錯誤
|
errors | array of DocumentError |
依文件識別碼的錯誤。 |
|
統計資料
|
statistics | RequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
模型版本
|
modelVersion | string |
此欄位指出用於評分的模型。 |
文件情緒
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
|
人氣
|
sentiment | string |
文件的預測情緒 （負面、中性、正面或混合）。 |
|
統計資料
|
statistics | DocumentStatistics |
如果在請求中指定了showStats=true，則此欄位將包含有關文件承載的資訊。 |
|
confidenceScores
|
confidenceScores | SentimentConfidenceScorePerLabel |
代表所有情緒類別介於 0 到 1 之間的信賴度分數：正面、中性、負面。 |
|
句子
|
sentences | array of SentenceSentiment |
句子級情感分析。 |
|
警告
|
warnings | array of TextAnalyticsWarning |
處理文件時遇到警告。 |
請求統計
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件計數
|
documentsCount | integer |
在請求中提交的文件數量。 |
|
validDocumentsCount
|
validDocumentsCount | integer |
有效文件數量。 這不包括空白、大小限制過大或不支援的語言文件。 |
|
錯誤文件計數
|
erroneousDocumentsCount | integer |
無效文件的數目。 這包括空白、大小限制或不支援的語言文件。 |
|
交易計數
|
transactionsCount | integer |
要求的交易數目。 |
文件統計
如果在請求中指定了showStats=true，則此欄位將包含有關文件承載的資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字元計數
|
charactersCount | integer |
文件中辨識的文字元素數目。 |
|
交易計數
|
transactionsCount | integer |
文件的交易數。 |
SentimentConfidenceScorePerLabel
代表所有情緒類別介於 0 到 1 之間的信賴度分數：正面、中性、負面。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
陽性
|
positive | double | |
|
中性
|
neutral | double | |
|
陰性
|
negative | double |
句子情感
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收發簡訊
|
text | string |
句子文本。 |
|
人氣
|
sentiment | string |
預測的句子情緒。 |
|
confidenceScores
|
confidenceScores | SentimentConfidenceScorePerLabel |
代表所有情緒類別介於 0 到 1 之間的信賴度分數：正面、中性、負面。 |
|
位移
|
offset | integer |
從文件開頭偏移的句子。 |
|
length
|
length | integer |
以 Unicode 標準計算的句子長度。 |
文件實體
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
|
entities
|
entities | array of Entity |
文件中已辨識的實體。 |
|
警告
|
warnings | array of TextAnalyticsWarning |
處理文件時遇到警告。 |
|
統計資料
|
statistics | DocumentStatistics |
如果在請求中指定了showStats=true，則此欄位將包含有關文件承載的資訊。 |
PiiDocumentEntities
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
|
已編輯文本
|
redactedText | string |
傳回已編輯的文字。 |
|
entities
|
entities | array of Entity |
文件中已辨識的實體。 |
|
警告
|
warnings | array of TextAnalyticsWarning |
處理文件時遇到警告。 |
|
統計資料
|
statistics | DocumentStatistics |
如果在請求中指定了showStats=true，則此欄位將包含有關文件承載的資訊。 |
實體
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收發簡訊
|
text | string |
請求中顯示的實體文字。 |
|
分類
|
category | string |
實體類型，例如人員/位置/組織/SSN 等 |
|
子類別
|
subcategory | string |
實體子類型，例如 Age/Year/TimeRange 等 |
|
位移
|
offset | integer |
實體文字的起始位置 （以 Unicode 字元為單位）。 |
|
length
|
length | integer |
實體文字的長度 （以 Unicode 字元為單位）。 |
|
confidenceScore
|
confidenceScore | double |
擷取實體的信賴度分數介於 0 到 1 之間。 |
EntityLinking結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of DocumentLinkedEntities |
按文件回應 |
|
錯誤
|
errors | array of DocumentError |
依文件識別碼的錯誤。 |
|
統計資料
|
statistics | RequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
模型版本
|
modelVersion | string |
此欄位指出用於評分的模型。 |
DocumentLinkedEntities
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
|
entities
|
entities | array of LinkedEntity |
文件中認可的知名實體。 |
|
警告
|
warnings | array of TextAnalyticsWarning |
處理文件時遇到警告。 |
|
統計資料
|
statistics | DocumentStatistics |
如果在請求中指定了showStats=true，則此欄位將包含有關文件承載的資訊。 |
連結實體
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
實體連結正式名稱。 |
|
比賽
|
matches | array of Match |
此實體出現在文字中的實例清單。 |
|
語言
|
language | string |
資料來源中使用的語言。 |
|
識別碼
|
id | string |
資料來源中已辨識實體的唯一識別碼。 |
|
url
|
url | string |
資料來源中實體頁面的 URL。 |
|
dataSource
|
dataSource | string |
用於提取實體鏈接的數據源，例如 Wiki/Bing 等。 |
Match
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
confidenceScore
|
confidenceScore | double |
如果辨識出已知項目，則會傳回表示 0 到 1 之間的信賴水準的十進位數。 |
|
收發簡訊
|
text | string |
請求中顯示的實體文字。 |
|
位移
|
offset | integer |
實體相符文字的起始位置 （以 Unicode 字元為單位）。 |
|
length
|
length | integer |
實體比對文字的長度 （以 Unicode 字元為單位）。 |
文件鍵詞組
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
|
關鍵詞組
|
keyPhrases | array of string |
代表性單字或片語的清單。 傳回的關鍵片語數目與輸入文件中的字數成正比。 |
|
警告
|
warnings | array of TextAnalyticsWarning |
處理文件時遇到警告。 |
|
統計資料
|
statistics | DocumentStatistics |
如果在請求中指定了showStats=true，則此欄位將包含有關文件承載的資訊。 |
文件語言
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
|
偵測到的語言
|
detectedLanguage | DetectedLanguage | |
|
警告
|
warnings | array of TextAnalyticsWarning |
處理文件時遇到警告。 |
|
統計資料
|
statistics | DocumentStatistics |
如果在請求中指定了showStats=true，則此欄位將包含有關文件承載的資訊。 |
偵測到的語言
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
偵測到的語言的長名稱（例如英語、法語）。 |
|
iso6391名稱
|
iso6391Name | string |
根據 ISO 639-1 標準（例如 en、fr）檢測到的語言的兩個字母表示。 |
|
confidenceScore
|
confidenceScore | double |
信賴分數介於 0 到 1 之間。 分數接近 1 表示 100% 確定所識別語言為真的。 |
KeyPhraseResultV3
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of DocumentKeyPhrases |
按文件回應 |
|
錯誤
|
errors | array of DocumentError |
依文件識別碼的錯誤。 |
|
統計資料
|
statistics | RequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
模型版本
|
modelVersion | string |
此欄位指出用於評分的模型。 |
實體結果V3
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of DocumentEntities |
按文件回應 |
|
錯誤
|
errors | array of DocumentError |
依文件識別碼的錯誤。 |
|
統計資料
|
statistics | RequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
模型版本
|
modelVersion | string |
此欄位指出用於評分的模型。 |
Pii結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of PiiDocumentEntities |
按文件回應 |
|
錯誤
|
errors | array of DocumentError |
依文件識別碼的錯誤。 |
|
統計資料
|
statistics | RequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
模型版本
|
modelVersion | string |
此欄位指出用於評分的模型。 |
語言結果V3
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of DocumentLanguage |
按文件回應 |
|
錯誤
|
errors | array of DocumentError |
依文件識別碼的錯誤。 |
|
統計資料
|
statistics | RequestStatistics |
如果在請求中指定了 showStats=true，則此欄位將包含有關請求承載的資訊。 |
|
模型版本
|
modelVersion | string |
此欄位指出用於評分的模型。 |
KeyPhrase結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of KeyPhraseResult |
實體結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of EntitiesResult |
語言結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of LanguageResult |
情緒結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of SentimentResult |
KeyPhraseResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
關鍵詞組
|
keyPhrases | array of string |
代表性單字或片語的清單。 傳回的關鍵片語數目與輸入文件中的字數成正比。 |
|
Id
|
id | string |
唯一文件識別碼。 |
實體結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
實體或單位
|
entities | array of object |
消除歧義的實體列表，其中包含指向網絡（維基百科和必應）上更多信息的鏈接。 |
|
名稱
|
entities.name | string |
實體的名稱。 |
|
相符
|
entities.matches | array of object |
實體的相符清單。 |
|
items
|
entities.matches | object | |
|
維基百科語言
|
entities.wikipediaLanguage | string |
實體的維基百科語言。 |
|
維基百科 ID
|
entities.wikipediaId | string |
實體的維基百科 ID。 |
|
維基百科網址
|
entities.wikipediaUrl | string |
實體的維基百科網址。 |
|
必應標識碼
|
entities.bingId | string |
實體的 Bing ID。 |
|
類型
|
entities.type | string |
實體的類型。 |
|
子類型
|
entities.subType | string |
實體的子類型。 |
|
Id
|
id | string |
唯一文件識別碼。 |
語言結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Id
|
id | string |
唯一文件識別碼。 |
|
偵測到的語言
|
detectedLanguages | array of DetectedLanguageV2 |
擷取的語言清單。 |
情緒結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Score
|
score | double |
介於 0 和 1 之間的十進位數，表示文件的情緒。 高於 0.7 的分數通常表示文件是正面的，而低於 0.3 的分數通常具有負面含義。 中間值是指中性文字。 |
|
Id
|
id | string |
唯一文件識別碼。 |
偵測到的語言V2
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
偵測到的語言的長名稱 （例如英文、法文）。 |
|
語言代碼
|
iso6391Name | string |
根據 ISO 639-1 標準（例如 en、fr）檢測到的語言的兩個字母表示。 |
|
Score
|
score | double |
信賴分數介於 0 到 1 之間。 分數接近 1 表示 100% 確定所識別語言為真的。 |
AnalyzeConversationTaskResultsKind
交談任務結果
交談工作的結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類型
|
kind | AnalyzeConversationTaskResultsKind |
列舉支援的交談工作結果 |
|
結果
|
result | AnalyzeConversationResult |
表示交談分析回應。 |
ConversationalTaskResult_Orchestration
交談工作的結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類型
|
kind | AnalyzeConversationTaskResultsKind |
列舉支援的交談工作結果 |
|
結果
|
result | AnalyzeConversationResult_Orchestration |
表示交談分析回應。 |
分析對話結果
表示交談分析回應。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
查詢
|
query | string |
呼叫端所提供的交談語句。 |
|
偵測到的語言
|
detectedLanguage | string |
系統偵測到 BCP 47 語言表示法中查詢的語言。 |
|
預測
|
prediction | ConversationPrediction |
代表 Conversation 專案的預測區段。 |
AnalyzeConversationResult_Orchestration
表示交談分析回應。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
查詢
|
query | string |
呼叫端所提供的交談語句。 |
|
偵測到的語言
|
detectedLanguage | string |
系統偵測到 BCP 47 語言表示法中查詢的語言。 |
|
預測
|
prediction | OrchestrationPrediction |
這代表協調流程項目的預測結果。 |
對話預測
代表 Conversation 專案的預測區段。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
意圖
|
intents | array of ConversationIntent |
意圖分類結果。 |
|
entities
|
entities | array of ConversationEntity |
實體擷取結果。 |
|
專案類型
|
projectKind | string |
專案的型別。 |
|
topIntent
|
topIntent | string |
最高分數的意圖。 |
對話意圖
Conversation 專案的意圖分類結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
分類
|
category | string |
預測類別。 |
|
confidenceScore
|
confidenceScore | float |
類別的信賴分數從 0.0 到 1.0。 |
對話實體
Conversation 項目的實體擷取結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
分類
|
category | string |
實體類別目錄。 |
|
收發簡訊
|
text | string |
預測實體文字。 |
|
位移
|
offset | integer |
查詢中這個實體的起始索引。 |
|
length
|
length | integer |
文字的長度。 |
|
confidenceScore
|
confidenceScore | float |
實體信賴分數。 |
|
決議
|
resolutions | array of BaseResolution |
實體解析物件的集合。 |
|
額外資訊
|
extraInformation | array of BaseExtraInformation |
實體額外信息物件的集合。 |
|
頂部解析度
|
topResolution | BaseResolution |
實體解析的抽象基類。 |
|
多個解析度
|
multipleResolutions | boolean |
表示 resolutions 陣列是否有多個專案的指標。 |
基本額外資訊
實體額外資訊的抽象基底物件。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
額外資訊種類
|
extraInformationKind | string |
額外的資訊物件種類。 |
基底解析度
實體解析的抽象基類。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
resolution種類
|
resolutionKind | string |
實體解析物件種類。 |
協調流程預測
這代表協調流程項目的預測結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
意圖
|
intents | object |
包含所有意圖的字典。 索引鍵是意圖名稱，而值是其信賴分數和目標類型。 最上層意圖的值也包含來自目標項目的實際回應。 |
|
專案類型
|
projectKind | string |
專案的型別。 |
|
topIntent
|
topIntent | string |
最高分數的意圖。 |
擷取摘要結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of ExtractedSummaryDocumentResultWithDetectedLanguage |
按文件回應 |
擷取摘要文件結果與偵測語言
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
句子
|
sentences | array of ExtractedSummarySentence |
代表擷取摘要的句子排名清單。 |
|
偵測到的語言
|
detectedLanguage | DetectedLanguage |
提取摘要句子
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收發簡訊
|
text | string |
擷取的句子文字。 |
|
排名分數
|
rankScore | double |
代表摘要中句子相關性的雙精度值。 值越高表示重要性越高。 |
|
位移
|
offset | integer |
從文件開頭開始的句子偏移量，以參數 StringIndexType 的值為基礎。 |
|
length
|
length | integer |
刑期的長度。 |
擷取摘要LROResult
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | ExtractiveSummarizationResult |
抽象摘要LROResult
代表抽象摘要工作結果的物件。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | AbstractiveSummarizationResult |
代表每個文件的建置前摘要結果的物件。 |
抽象摘要結果
代表每個文件的建置前摘要結果的物件。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔
|
documents | array of AbstractiveSummaryDocumentResultWithDetectedLanguage |
按文件回應 |
AbstractiveSummaryDocumentResultWithDetectedLanguage
代表具有偵測到語言的單一文件摘要結果的物件。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
summaries
|
summaries | array of AbstractiveSummary |
抽象摘要清單。 |
|
識別碼
|
id | string |
唯一的非空白文件識別碼。 |
|
警告
|
warnings | array of LanguageDocumentWarning |
處理文件時遇到警告。 |
|
統計資料
|
statistics | DocumentStatistics |
如果在請求中指定了showStats=true，則此欄位將包含有關文件承載的資訊。 |
|
偵測到的語言
|
detectedLanguage | DetectedLanguage |
摘要內容
摘要的上下文。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
位移
|
offset | integer |
內容的起始位置。 使用不同的 'stringIndexType' 值可能會影響傳回的位移量。 |
|
length
|
length | integer |
內容的長度。 使用不同的 'stringIndexType' 值可能會影響傳回的長度。 |
抽象摘要
一個物件，代表具有指定文件上下文的單一摘要。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收發簡訊
|
text | string |
摘要的文字。 |
|
contexts
|
contexts | array of SummaryContext |
摘要的內容清單。 |
答案結果
代表問題解答清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
answers
|
answers | array of KnowledgeBaseAnswer |
代表答案結果清單。 |
|
isUserQuestion模棱兩可
|
isUserQuestionAmbiguous | boolean |
如果使用者的問題不明確，則傳回布林值。 |
知識庫答案
代表專案答案。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
問題
|
questions | array of string |
與答案相關聯的問題清單。 |
|
答
|
answer | string |
回答文字。 |
|
信賴度臨界值
|
confidenceScore | float |
回答信賴分數，值範圍從 0 到 1。 |
|
QnA 識別碼
|
id | integer |
QnA 結果的標識碼。 |
|
來源
|
source | string |
QnA 結果的來源。 |
|
中繼資料
|
metadata | object |
與答案相關聯的元數據，有助於分類或篩選問題解答。 |
|
對話
|
dialog | KnowledgeBaseAnswerDialog |
與 Answer 相關聯的對話方塊。 |
|
答案跨度
|
answerSpan | AnswerSpan |
回答 QnA 的 span 物件。 |
知識庫AnswerDialog
與 Answer 相關聯的對話方塊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
isContextOnly
|
isContextOnly | boolean |
若要標記提示是否只與先前的問題相關。 如果為 true，請勿將此 QnA 包含為沒有內容之查詢的搜尋結果;否則，如果為 false，則會忽略內容，並在搜尋結果中包含此 QnA。 |
|
提示
|
prompts | array of KnowledgeBaseAnswerPrompt |
與答案相關聯的提示清單。 |
知識庫AnswerPrompt
提示輸入答案。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
顯示順序
|
displayOrder | integer |
提示的索引 - 用於提示的順序。 |
|
qnaId
|
qnaId | integer |
對應至提示的 QnA 識別碼。 |
|
顯示文字
|
displayText | string |
顯示來代表後續問題提示的文字。 |
答案跨度
回答 QnA 的 span 物件。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收發簡訊
|
text | string |
精確答案的預測文本。 |
|
信賴度臨界值
|
confidenceScore | float |
精確答案的預測分數，值範圍從 0 到 1。 |
|
位移
|
offset | integer |
精確答案從答案的開頭偏移。 |
|
length
|
length | integer |
精確答案的長度。 |