Udostępnij przez

Przegląd API podsumowania danych (wersja zapoznawcza)

[Ten artykuł stanowi wstępną wersję dokumentacji i może ulec zmianie.]

Twórcy korzystają z interfejsu API Power Pages do tworzenia streszczeń, aby dodawać streszczenia treści stron za pomocą generatywnej sztucznej inteligencji. Ta funkcja umożliwia użytkownikom witryny zapoznanie się z zawartością strony bez czytania całej strony. Interfejs API jest oparty na interfejsie API sieci Web Power Pages, który zapewnia podsumowanie danych dla tabel Dataverse używanych na stronach.

Ważne

  • Jest to funkcja w wersji zapoznawczej.
  • Funkcje w wersji zapoznawczej nie są przeznaczone do użytku w środowiskach produkcyjnych i mogą mieć ograniczoną funkcjonalność. Te funkcje podlegają dodatkowym warunkom i są udostępniane przed oficjalnym wydaniem, dzięki czemu klienci mogą szybciej uzyskać do nich dostęp i przekazać opinie na ich temat.

Wymagania wstępne

  • Włącz ustawienia witryny dla interfejsu API sieci Web..
  • Podsumowanie jest dostępne tylko dla tabel obsługiwanych przez interfejs API Power Pages. Więcej informacji na temat interfejsu API Power Pages Web API można znaleźć w sekcji Omówienie interfejsu API Web.
  • Ta funkcja nie jest dostępna w regionach Government Community Cloud (GCC), Government Community Cloud — High (GCC High) i Department of Defense (DoD).

Ustawienia witryny

Włącz strony w internetowym interfejsie API i ustaw następujące ustawienia witryny dla funkcji interfejsu API podsumowania.

Nazwa ustawień witryny Podpis
Summarization/Data/Enable Włączenie lub wyłączenie funkcji podsumowania.
Domyślnie: false
Prawidłowe wartości to true i false
Summarization/prompt/{any_identifier}

Użyj tych ustawień, aby podać instrukcje dotyczące podsumowania.
Typ: Ciąg

Przykład:
Nazwa: Summarization/prompt/case_summary
Wartość: Podsumuj kluczowe szczegóły i krytyczne informacje
Summarization/Data/ContentSizeLimit Zmodyfikuj limit rozmiaru danych wejściowych dla zawartości podsumowania.
Typ: Liczba całkowita
Ustawienie domyślne: 100000 znaków

Schemat systemu API

Method URI Przykład JSON:
POST [Site URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Nazwa właściwości Podpis
InstructionIdentifier Ta właściwość jest opcjonalna. Aby przekazać dodatkowe instrukcje dotyczące podsumowania, użyj ustawień witryny w celu dodania monitu. Zawsze podawaj nazwę ustawienia witryny w takiej postaci, w jakiej została wcześniej zdefiniowana.
RecommendationConfig Ta właściwość jest opcjonalna. Użyj tej właściwości, aby przekazać monit zalecany przez interfejs API podsumowania. Wartość musi być skrótem i pozostać niezmodyfikowana.

Notatka

Interfejs API jest zgodny ze standardowymi specyfikacjami protokołu Open Data Protocol (OData) obsługiwanymi przez interfejs API sieci Web Power Pages. Interfejs API podsumowania obsługuje wszystkie operacje operacje odczytu dostępne w Power Pages Web API.

Sample

Podsumuj typ, temat, opis i historię przypadku, koncentrując się na kluczowych szczegółach i ważnych informacjach.

Zażądaj

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

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

Odpowiedź podsumowująca dostarcza zalecanych promptów do dopracowania podsumowania. Aby skorzystać z tych zaleceń, przekaż wartość konfiguracyjną w treści żądania bez właściwości InstructionIdentifier.

Zabezpieczenia

Interfejs API podsumowania uwzględnia zabezpieczenia oparte na rolach skonfigurowane dla uprawnień do tabel i kolumn. Uwzględnia tylko rekordy, do których użytkownik może uzyskać dostęp w celu podsumowania.

Uwierzytelnianie interfejsu API podsumowania

Nie ma potrzeby dołączania kodu uwierzytelniającego, ponieważ sesja aplikacji zarządza uwierzytelnianiem i autoryzacją. Wszystkie wywołania usługi Web API muszą zawierać token podrabiania żądania między witrynami (CSRF).

Kody i komunikaty o błędach

W poniższej tabeli opisano różne kody błędów i komunikaty, które mogą wystąpić podczas korzystania z interfejsu API podsumowania.

Kod stanu Kod błędu Wiadomość z błędem
400 90041001 Generatywne funkcje AI są wyłączone
400 90041003 Podsumowanie danych wyłączone dla tej strony. Włącz za pomocą ustawień witryny.
400 90041004 Długość treści przekracza limit
400 90041005 Nie znaleziono rekordów do podsumowania
400 90041006 Wystąpił błąd podczas podsumowywania treści.

FAQ dla interfejsu API podsumowującego dane

  • Last updated on