Edit

Share via

Data summarization API overview (preview)

  • Article

[This article is prerelease documentation and is subject to change.]

Power Pages summarization API lets makers add a page content summarization using generative AI that helps site users get an overview without going over the entire page. The API is built on top of the Power Pages Web API that provides data summarization on Dataverse tables used in the pages.

Important

  • This is a preview feature.
  • Preview features aren’t meant for production use and might have restricted functionality. These features are subject to supplemental terms of use, and are available before an official release so that customers can get early access and provide feedback.

Prerequisites

  • You must enable the site settings for Web API.

  • Only tables supported for Pages Web API are available for summarization. Learn more about the Pages Web API at Web API overview.

  • The feature isn't available in Government Community Cloud (GCC), Government Community Cloud - High (GCC High), or Department of Defense (DoD) regions.

Site settings

Enable the pages in your web API and set site settings for the summarization API feature.

Site setting name Description
Summarization/Data/Enable Enables or disables the Summarization feature.
Default: False
Valid values: True, False
Summarization/prompt/{any_identifier} Use these settings to provide any instruction for summarization
Type: string
Example:
Name: Summarization/prompt/case_summary
Value: Summarize key details and critical information
Summarization/Data/ContentSizeLimit Modify the input size limit for the summarization content
Type: integer
Default: 100 K

API schema

Method URI
POST [Site URI]/_api/summarization/data/v1.0/tablename{ "InstructionIdentifier":"", "RecommendationConfig":"" }
Name Description
InstructionIdentifier This property is optional. If you want to pass any other instruction to summarization, use the site settings to add the prompt.
You should always provide the site setting name as defined previously.
RecommendationConfig This property is optional. If you pass the recommended prompt provided by the summarization API, use this parameter to pass. The value should be hashed and not modified.

Note

The API follows the standard OData specifications supported by the Power Pages Web API. The Summarization API supports all read operations that the Power Pages web API supports.

Sample

Summarize case type, subject, description, and case history by focusing on key details and critical information.

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"
}

Response

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="
    }
  ]
}

The summarization response provides recommended prompts for fine-tuning the summary. If you wish to use these recommendations, pass the configuration value in the request body without the InstructionIdentifier.

Security

The summarization API respects the role-based security configured for table and column permissions. It only considers the records that the user has access to for summarization.

Authenticating summarization API

You don't need to include an authentication code because the application session manages authentication and authorization. All Web API calls must include a Cross-Site Request Forgery (CSRF) token.

Error codes and messages

The following table includes the different error codes and messages you might encounter when you use the summarization API:

Status Code Error Code Error Message
400 90041001 Generative AI Features are disabled
400 90041003 Data summarization disabled for this site. Enable using the site setting.
400 90041004 Content length exceeds the limit
400 90041005 No records found to summarize
400 90041006 Error occurred while summarizing the content.

FAQ for data summarization API