データ要約 API の概要 (プレビュー)

[この記事はプレリリース ドキュメントであり、変更されることがあります。]

作成者は Power Pages 要約 API を使用して、生成 AI を使用してページ コンテンツの概要を追加します。 この機能を使用すると、サイト ユーザーはページ全体を読むことなく、ページのコンテンツの概要を把握できます。 この API は Power Pages Web API に基づいて構築されており、ページで使用される Dataverse テーブルのデータ要約を提供します。

前提条件

• Web API のサイト設定を有効にします。
• 集計に使用できるのは Power Pages Web API でサポートされているテーブルのみです。 Web API 概要で Power Pages Web API に関する詳細を参照してください。
• この機能は、Government Community Cloud (GCC)、Government Community Cloud - High (GCC High)、国防総省 (DoD) のリージョンでは利用できません。

サイト設定

Web API でページを有効にし、要約 API 機能に対して次のサイト設定を行います。

API スキーマ

サンプル

ケースの種類、件名、説明、ケース履歴を、重要な詳細と重要な情報に焦点を当てて要約します。

要求

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

Body:
{
"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 を使用するときに発生する可能性のあるさまざまなエラー コードとメッセージが含まれています。

関連情報

データ要約APIに関するFAQ