Поділитися через

Огляд API підсумовування даних (підготовча версія)

  • Стаття

[Ця стаття стосується інструкції до попередньої версії, і її буде змінено.]

Виробники Power Pages можуть використовувати API підсумовування, щоб додати підсумок вмісту сторінки, який використовує генеративний штучний інтелект. Таким чином, користувачі сайту можуть отримати огляд вмісту сторінки без необхідності переглядати всю сторінку. API побудований поверх Power Pages веб-API, який забезпечує підсумовування даних по Dataverse таблицях, які використовуються на сторінках.

Важливо

  • Це функція попереднього перегляду.
  • Підготовчі функції призначені для невиробничого використання. Їх можливості можуть бути обмеженими. Ці функції регулюються додатковими умовами використання та доступні перед офіційним випуском, щоб клієнти могли отримати ранній доступ і залишити відгук.

вимоги

  • Необхідно включити налаштування сайту для Web API.
  • Для підсумовування доступні тільки таблиці, які підтримуються для Power Pages Web API. Дізнайтеся більше про Power Pages веб-API в огляді веб-API.
  • Ця функція недоступна в регіонах Government Community Cloud (GCC), Government Community Cloud (High (GCC High) або Міністерства оборони (DoD).

Параметри сайту

Увімкніть сторінки у вашому веб-API та встановіть наступні налаштування сайту для функції API підсумовування.

Назва параметра сайту Опис
Підсумок/Дані/Увімкнути Увімкніть або вимкніть функцію підсумовування.
Типове значення: Брехня
Допустимі значення: True, False
Підбиття підсумків/підказка/{any_identifier}

Використовуйте ці параметри, щоб надати будь-які інструкції для узагальнення.
Тип: string

Приклад:
Назва: Підсумок/підказка/case_summary
Значення: узагальнюйте ключові деталі та критичну інформацію
Підсумок/Дані/Ліміт розміру контенту Змініть обмеження розміру вхідного сигналу для вмісту підсумовування.
Тип: ціле число
Типове значення: 100,000

Схема API

Спосіб зв’язку URI Зразок JSON
POST [URI сайту]/_api/підсумок/дані/v1.0/назва_набору { "InstructionIdentifier":"", "RecommendationConfig":"" }
Ім’я властивості Опис
Ідентифікатор інструкції Ця властивість не є обов’язковою. Якщо ви хочете передати будь-які інші інструкції для підсумовування, скористайтеся налаштуваннями сайту для додавання підказки. Ви завжди повинні вказувати назву налаштувань сайту так, як вона була визначена раніше.
РекомендаціяConfig Ця властивість не є обов’язковою. Якщо ви хочете передати запит, який рекомендує API підсумовування, використовуйте цю властивість для його передачі. Значення має бути хешованим, а не зміненим.

Нотатка

API відповідає стандартним специфікаціям Open Data Protocol (OData), які Power Pages підтримує Web API. API підсумовування підтримує всі операції читання, які Power Pages підтримує веб-API.

Sample

Узагальніть тип справи, тему, опис та історію хвороби, зосередившись на ключових деталях та важливій інформації.

Надіслати запит

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 підсумовування.

Код стану Код помилки Повідомлення про помилку
400 90041001 Функції генеративного ШІ вимкнено
400 90041003 Підсумовування даних вимкнено для цього сайту. Увімкніть за допомогою налаштувань сайту.
400 90041004 Довжина контенту перевищує ліміт
400 90041005 Не знайдено записів для узагальнення
400 90041006 Під час узагальнення змісту сталася помилка.

FAQ для API підсумовування даних