通过

数据摘要 API 概览（预览）

  • 项目

[本文为预发布文档，可能会发生变化。]

Power Pages 摘要 API 允许制作者使用生成式人工智能添加页面内容摘要，这有助于网站用户在不浏览整个页面的情况下获得概述。 该 API 建立在 Power Pages Web API的基础上，提供页面中使用的 Dataverse 表格的数据摘要。

重要提示

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

先决条件

  • 必须启用 Web API 的网站设置。

  • 只有 Pages Web API 支持的表可供摘要使用。 请访问 Web API 概述，了解有关 Pages Web API 的更多信息。

  • 该功能在 Government 社区云 (GCC)、 Government 社区云 – High (GCC High) 或国防部 (DoD) 地区不可用。

站点设置

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

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

API 架构

Method URI
POST [Site URI]/_api/summarization/data/v1.0/tablename{ "InstructionIdentifier":"", "RecommendationConfig":"" }
Name Description
InstructionIdentifier 该属性是可选的。 如果要传递任何其他说明到摘要，请使用网站设置来添加提示。
您应当始终提供之前定义的网站设置名称。
RecommendationConfig 该属性是可选的。 如果您通过了摘要 API 提供的建议提示，请使用此参数通过。 该值应哈希处理，不能修改。

备注

该 API 遵循Power Pages Web API 支持的标准 OData 规范。 摘要 API 支持 Power Pages web API 支持的所有读取操作。

示例

通过重点关注关键详细信息和关键信息，对案例类型、主题、说明和案例历史记录进行汇总。

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 时可能遇到的不同的错误代码和消息：

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

数据摘要 API 常见问题