다음을 통해 공유

데이터 요약 API 개요(프리뷰)

  • 아티클

[이 문서는 시험판 설명서이므로 변경될 수 있습니다.]

제작자는 요약 API를 Power Pages 사용하여 생성형 AI를 사용하는 페이지 콘텐츠 요약을 추가할 수 있습니다. 이러한 방식으로 사이트 사용자는 전체 페이지를 살펴보지 않고도 페이지 콘텐츠의 개요를 볼 수 있습니다. API는 페이지에서 사용되는 Dataverse 테이블에 대한 데이터 요약을 제공하는 Power Pages 웹 API를 기반으로 합니다.

중요

  • 이는 프리뷰 기능입니다.
  • 프리뷰 기능은 프로덕션용으로 만들어진 것이 아니므로 기능이 제한될 수 있습니다. 이러한 기능에는 추가 사용 약관이 적용되며, 고객이 조기에 액세스하고 피드백을 제공할 수 있도록 공식 출시 전에 제공됩니다.

사전 요구 사항

  • 웹 API에 대한 사이트 설정을 활성화해야 합니다.
  • Web API에 대해 Power Pages 지원되는 테이블만 요약에 사용할 수 있습니다. Web API 개요 Power Pages 에서 Web API에대해 자세히 알아보세요.
  • 이 기능은 GCC(Government Community Cloud), GCC High(Government Community Cloud - High), DoD(국방부) 지역에서 사용할 수 없습니다.

사이트 설정

Web API에서 페이지를 사용하도록 설정하고 요약 API 기능에 대해 다음 사이트 설정을 지정합니다.

사이트 설정 이름 Description
요약/데이터/활성화 요약 기능을 활성화하거나 비활성화합니다.
기본값: False
유효한 값: True, False
요약/프롬프트/{any_identifier}

이러한 설정을 사용하여 요약에 대한 지침을 제공합니다.
유형: 문자열

예:
이름: 요약/프롬프트/case_summary
값: 주요 세부 정보 및 중요 정보 요약
요약/데이터/ContentSizeLimit 요약 내용에 대한 입력 크기 제한을 수정합니다.
유형: 정수
기본값: 100,000

API 스키마

방법 URI JSON 샘플
게시 [사이트 URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Property name Description
InstructionIdentifier 이 속성은 선택 사항입니다. 요약에 대한 다른 지침을 전달하려면 사이트 설정을 사용하여 프롬프트를 추가합니다. 사이트 설정 이름은 항상 이전에 정의된 대로 제공해야 합니다.
RecommendationConfig 이 속성은 선택 사항입니다. 요약 API에서 권장하는 프롬프트를 전달하려면 이 속성을 사용하여 전달합니다. 값은 해시되어야 하며 수정되지 않아야 합니다.

참고

API는 Web API에서 지원하는 표준 OData(Open Data Protocol) 사양을 Power Pages 따릅니다. 요약 API는 Power Pages 웹 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 인증

애플리케이션 세션이 인증 및 권한 부여를 관리하므로 인증 코드를 포함할 필요가 없습니다. 모든 웹 API 호출에는 CSRF(교차 사이트 요청 위조) 토큰이 포함되어야 합니다.

오류 코드 및 메시지

다음 표에서는 요약 API를 사용할 때 발생할 수 있는 다양한 오류 코드 및 메시지에 대해 설명합니다.

상태 코드 오류 코드 Error message
400 90041001 생성형 AI 기능이 비활성화됨
400 90041003 이 사이트에 대한 데이터 요약을 사용할 수 없습니다. 사이트 설정을 사용할 수 있습니다.
400 90041004 콘텐츠 길이가 제한을 초과합니다
400 90041005 요약할 레코드 없음
400 90041006 내용을 요약하는 동안 오류가 발생했습니다.

데이터 요약 API 관련 FAQ