共用方式為

資料摘要 API 概覽 (預覽版)

  • 發行項

[本文章是發行前版本文件，隨時可能變更。]

Power Pages 摘要 API 讓製作者使用生成式 AI 新增頁面內容摘要，幫助網站使用者在不瀏覽整個頁面的情況下獲得概覽。 該 API 建立在提供頁面中使用的 Dataverse 資料表資料摘要的 Power Pages Web API 之上。

重要

  • 這是預覽功能。
  • 預覽功能不供生產時使用，而且可能功能受限。 這些功能應受補充使用規定規範，並且是在正式發行前先行推出，讓客戶可以搶先體驗並提供意見反應。

先決條件

  • 必須啟用 Web API 的網站設定。

  • 只有頁面 Web API 支援的表才可用於摘要。 有關頁面 Web API 的詳細資訊，請參閱 Web API 概述。

  • 此功能在政府社區雲 (GCC)、政府社區雲 - 高 (GCC High) 或國防部 (DoD) 區域中不可用。

網站設定

啟用 Web API 中的頁面，並為資料摘要 API 功能設置網站設定。

網站設定名稱 說明
摘要/資料/啟用 啟用或停用資料摘要功能。
預設值： False
有效值： True、False
Summarization/prompt/{any_identifier} 使用這些設定來提供任何摘要指令
類型：字串
範例：
名稱：摘要/提示/案例摘要
值：摘要關鍵細節和重要資訊
摘要/資料/內容大小限制 修改匯總內容的輸入大小限制
類型：整數
預設值：100 K

API 結構描述

Method URI
POST [Site URI]/_api/summarization/data/v1.0/tablename{ "InstructionIdentifier":"", "RecommendationConfig":"" }
名字 說明
指令標識碼 此屬性是選擇性的。 如果要將任何其他指令傳遞給摘要功能，請使用網站設定新增提示。
應始終提供之前定義的網站設置名稱。
RecommendationConfig 此屬性是選擇性的。 如果傳遞摘要 API 提供的建議提示，請使用此參數傳遞。 該值應經過哈希處理，而不是修改。

注意

此 API 遵循由 Power Pages Web API 支援標準 OData 規範。 摘要 API 支援所有 Power Pages Web API 支援的讀取作業。

範例

通過關注關鍵細節和關鍵資訊來總結案例類型、主題、描述和案例歷史記錄。

Request

POST [Power Pages URL]/_api/summarization/data/v1.0/incidents(aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb)?$select=description,title&$expand=incident_adx_portalcomments($select=description)
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0
Accept: application/json
{
"InstructionIdentifier": "Summarization/prompt/case_summary"
}

回應

HTTP/1.1 200 OK
OData-Version: 4.0
{
  "Summary": "The data results provide information…...",
  "Recommendations": [
    {
      "Text": "would you like to know about…?",
      "Config": "HSYmaicakjvIwTFYeCIjKOyC7nQ4RTSiDJ+/LBK56r4="
    }
  ]
}

摘要回應提供了用於微調摘要的建議提示。 如果您希望使用這些建議，請在請求主體中傳遞設定值，而不包含 InstructionIdentifier。

安全性

資料摘要 API 遵循為資料表和資料行授權設定的角色型安全性。 這僅考慮使用者有權存取的記錄以進行摘要。

驗證摘要 API

您不需要包括驗證代碼，因為應用程式工作階段會管理驗證和授權。 所有的 Web API 呼叫都必須包括跨網站偽造要求 (CSRF) 權杖。

錯誤代碼和訊息

下表包含使用摘要 API 時可能遇到的不同錯誤代碼和訊息：

狀態碼 錯誤碼 錯誤訊息
400 90041001 生成式 AI 功能已停用
400 90041003 此網站已停用資料匯總。 請使用網站設定來啟用。
400 90041004 內容長度超過限制
400 90041005 找不到要摘要的記錄
400 90041006 摘要內容時發生錯誤。

資料匯總 API 常見問題