次の方法で共有

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

  • [アーティクル]

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

作成者は Power Pages 要約 API を使用して、生成 AI を使用するページ コンテンツの要約を追加できます。 このようにして、サイト ユーザーは、ページ全体を調べることなく、ページのコンテンツの概要を取得できます。 この API は、ページで使用される Power Pages テーブルのデータ要約を提供する Web API Dataverse 上に構築されています。

重要

  • これはプレビュー機能です。
  • プレビュー機能は運用環境での使用を想定しておらず、機能が制限されている可能性があります。 これらの機能は、追加の使用条件の対象となり、正式リリース前に利用可能です。お客様は早期にアクセスし、フィードバックを提供することができます。

前提条件

  • Web API の サイト設定 を有効にする必要があります。
  • Web API でサポートされているテーブルのみ Power Pages 集計に使用できます。 Web API の詳細については Power Pages Web API の概要 を参照してください。
  • この機能は、ガバメント コミュニティ クラウド (GCC)、ガバメント コミュニティ・クラウド - ハイ (GCC High)、または国防総省 (DoD) のリージョンでは利用できません。

サイト設定

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

サイト設定の名前 プロパティ
Summarization/Data/Enable 要約機能を有効または無効にします。
既定: False
有効な値: True または False
Summarization/prompt/{any_identifier}

これらの設定を使用して、集計の指示を提供します。
種類: 文字列

例:
名前: Summarization/prompt/case_summary
値: 重要な詳細と重要な情報を要約する
Summarization/Data/ContentSizeLimit 要約コンテンツの入力サイズ制限を変更します。
種類: 整数
既定: 100,000

API スキーマ

メソッド URI JSON サンプル
投稿 [サイト URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
プロパティ名 プロパティ
InstructionIdentifier このプロパティはオプションです。 要約のための他の指示を渡す場合は、サイトの設定を使用してプロンプトを追加します。 サイト設定名は、以前に定義された通りに指定してください。
RecommendationConfig このプロパティはオプションです。 要約 API が推奨するプロンプトを渡す場合は、このプロパティを使用して渡します。 値はハッシュ化され、変更されてはいけません。

ヒント

この API は、Web API がサポートする標準 Power Pages Open Data Protocol (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に関するFAQ