数据摘要 API 概览（预览）

项目
12/31/2024

[本文是预发行文档，可能会有所更改。]

制作者可以使用 Power Pages 摘要 API 添加使用生成式 AI 的页面内容摘要。通过这种方式，网站用户可以大致了解页面内容，而无需浏览整个页面。该 API 基于 Power Pages Web API 构建，Web API 提供对 Dataverse 页面上使用的表的数据摘要。

重要提示

这是一项预览功能。
预览功能不适用于生产环境，并且可能具有受限的功能。这些功能受补充使用条款约束，在正式发布之前已经可用，以便客户可以及早使用并提供反馈。

先决条件

必须启用 Web API 的网站设置。
只有 Power Pages Web API 支持的表可供摘要使用。请访问 Web API 概述，了解有关 Power Pages Web API 的更多信息。
该功能在 Government 社区云 (GCC)、 Government 社区云 – High (GCC High) 或国防部 (DoD) 地区不可用。

站点设置

在 Web API 中启用页面，并设置摘要 API 功能的以下网站设置。

站点设置名称	Description
摘要/数据/启用	启用或禁用摘要功能。默认：False 有效值：True、False
Summarization/prompt/{any_identifier}	使用这些设置可提供任何摘要说明。类型：字符串示例: 名称： Summarization/prompt/case_summary 值：总结关键细节和重要信息
摘要/数据/ContentSizeLimit	修改汇总内容的输入大小限制。类型：整数默认值：100,000

站点设置名称

Description

摘要/数据/启用

启用或禁用摘要功能。
默认：False
有效值：True、False

Summarization/prompt/{any_identifier}

使用这些设置可提供任何摘要说明。
类型：字符串

示例:
名称： Summarization/prompt/case_summary
值：总结关键细节和重要信息

摘要/数据/ContentSizeLimit

修改汇总内容的输入大小限制。
类型：整数
默认值：100,000

API 架构

方法	URI	JSON 示例
POST	[站点 URI]/_api/summarization/data/v1.0/tablesetname	`{ "InstructionIdentifier":"", "RecommendationConfig":"" }`

属性名称	Description
InstructionIdentifier	该属性是可选的。如果要传递任何其他说明到摘要，请使用网站设置来添加提示。您应当始终提供之前定义的网站设置名称。
RecommendationConfig	该属性是可选的。如果要传递摘要 API 建议的提示，请使用此属性传递它。该值应哈希处理，不能修改。

备注

该 API 遵循 Web API 支持的标准开放数据协议（OData）规范 Power Pages 。摘要 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"
}

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

摘要回复可提供微调摘要的建议提示。如果要使用这些建议，请在请求正文中传递配置值，而不传递 InstructionIdentifier 该属性。

安全组

汇总 API 遵循为表和列权限配置的基于角色的安全性。只有用户有访问权限的记录才会被视为摘要。

对摘要 API 进行身份验证

您不需要包括身份验证代码，因为应用程序会话管理身份验证和授权。所有 Web API 调用都必须包含跨站点请求伪造 (CSRF) 令牌。

错误代码和消息

下表描述使用摘要 API 时可能遇到的不同的错误代码和消息。

状态代码	错误代码	Error message
400	90041001	生成式人工智能功能被禁用
400	90041003	此站点禁用数据汇总。启用使用站点设置。
400	90041004	内容长度超出限制
400	90041005	未找到要汇总的记录
400	90041006	在汇总内容时出错。

数据摘要 API 常见问题

通过