共用方式為

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

  • 發行項

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

製作者可以使用 Power Pages 摘要 API 新增使用生成式 AI 的頁面內容摘要。 透過這種方式，網站使用者無需瀏覽整個頁面即可獲得頁面內容的概覽。 該 API 建立在 Power Pages Web API 之上，該 API 提供對用於頁面的 Dataverse 資料表的資料摘要功能。

重要

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

必要條件

  • 您必須啟用 Web API 的網站設定。
  • 僅 Power Pages Web API 支援的資料表可用於摘要。 有關 Power Pages Web API 的詳細資訊，請參閱 Web API 概述。
  • 此功能在政府社群雲端 (GCC)、政府社群雲端 - High (GCC High) 或國防部 (DoD) 區域不可用。

網站設定

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

網站設定名稱 Description
摘要/資料/啟用 啟用或停用摘要功能。
預設值：False
有效值：True、False
Summarization/prompt/{any_identifier}

使用這些設定來提供任何摘要說明。
類型：字串

範例:
名稱：Summarization/prompt/case_summary
值：摘要關鍵細節和關鍵訊息
Summarization/Data/ContentSizeLimit 修改摘要內容的輸入大小限制。
類型：整數
預設值：100,000

API 結構描述

方法 URI JSON 範例
POST [網站 URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
屬性名稱 Description
InstructionIdentifier 此屬性是選擇性的。 如果您想傳遞任何其他說明進行摘要，請使用網站設定新增提示。 您應始終提供先前定義的網站設定名稱。
RecommendationConfig 此屬性是選擇性的。 如果您想傳遞摘要API建議的提示，請使用此屬性來傳遞。 該值應該被散列而不是被修改。

注意

API 遵循 Power Pages Web API 支援的標準開放資料協定 (OData) 規格。 摘要 API 支援 Power Pages Web API 支援的所有讀取作業。

Sample

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

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 時可能遇到的不同錯誤代碼和訊息。

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

資料匯總 API 常見問題