Udostępnij za pośrednictwem

Przegląd API podsumowania danych (wersja zapoznawcza)

  • Artykuł

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

Twórcy mogą użyć Power Pages interfejsu API podsumowania, aby dodać podsumowanie zawartości strony, które korzysta z generatywnej sztucznej inteligencji. W ten sposób użytkownicy witryny mogą uzyskać przegląd zawartości strony bez konieczności przechodzenia przez całą stronę. Interfejs API jest oparty na internetowym interfejsie Power Pages API, który zapewnia podsumowanie danych w tabelach 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

  • Należy włączyć ustawienia witryny dla internetowego interfejsu API.
  • Do podsumowania dostępne są tylko tabele obsługiwane przez Power Pages internetowy interfejs API. Dowiedz się więcej o internetowym interfejsie Power Pages API w omówieniu internetowego interfejsu API.
  • Funkcja ta nie jest dostępna w regionach Government Community Cloud (GCC), Government Community Cloud - High (GCC High) ani 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ślna: 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: Podsumowanie/monit/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
Domyślnie: 100 000

Schemat systemu API

Method Identyfikator 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. Jeśli chcesz przekazać inne instrukcje dotyczące podsumowania, użyj ustawień witryny, aby dodać monit. Zawsze należy podać nazwę ustawienia witryny w takiej postaci, w jakiej została wcześniej zdefiniowana.
RecommendationConfig Ta właściwość jest opcjonalna. Jeśli chcesz przekazać monit zalecany przez interfejs API podsumowania, użyj tej właściwości, aby go przekazać. Wartość powinna być zaszyfrowana i niemodyfikowana.

Notatka

Interfejs API jest zgodny ze standardowymi specyfikacjami protokołu OData (Open Data Protocol) obsługiwanymi przez Power Pages internetowy interfejs API. Interfejs API podsumowania obsługuje wszystkie operacje odczytu, które obsługuje interfejs sieciowy Power Pages API.

Sample

Podsumuj typ, temat, opis i historię sprawy, koncentrując się na kluczowych szczegółach i krytycznych 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
{
"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. Jeśli chcesz użyć tych zaleceń, przekaż wartość konfiguracji w treści żądania bez InstructionIdentifier właściwości.

Zabezpieczenia

Interfejs API podsumowania uwzględnia zabezpieczenia oparte na rolach, które są skonfigurowane dla uprawnień do tabel i kolumn. Tylko rekordy, do których użytkownik ma dostęp, są brane pod uwagę podczas podsumowywania.

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