Общ преглед на API за обобщаване на данни (предварителен преглед)

[Тази статия е предварително издание на документацията и подлежи на промяна.]

Създателите Power Pages използват API за обобщаване, за да добавят обобщение на съдържанието на страницата с генеративен AI. Тази функция позволява на потребителите на сайта да получат общ преглед на съдържанието на страницата, без да четат цялата страница. API е изграден върху Power Pages уеб API, който осигурява обобщаване на данни за Dataverse таблици, използвани на страници.

Важно

  • Това е функция за предварителен преглед.
  • Функциите на етап преглед не са предназначени за производствена употреба и може да са с ограничени възможности. Тези функции са предмет на допълнителни условия за ползване и са налични преди официалното издание, така че клиентите да могат да получат ранен достъп и да предоставят обратна връзка.

Предварителни изисквания

  • Разрешете настройките на сайта за уеб API.
  • Само таблици, поддържани Power Pages от уеб API, са налични за обобщаване. Научете повече за Power Pages уеб API в Общ преглед на уеб API.

Настройки на сайт

Активирайте страници във вашия уеб API и задайте следните настройки на сайта за функцията за API за обобщаване.

Име на настройка на сайт Описание
Обобщаване/Данни/Активиране Активирайте или деактивирайте функцията за обобщаване.
По подразбиране: false
Валидни стойности: true,false
Обобщаване/подкана/{any_identifier}

Използвайте тези настройки, за да предоставите инструкции за обобщаване.
Тип: низ

Пример:
Име: Обобщаване/подкана/case_summary
Стойност: Обобщете ключови подробности и критична информация
Обобщаване/Данни/ContentSizeLimit Променете ограничението на входния размер за обобщаващо съдържание.
Тип: цяло число
По подразбиране: 100000 символа

API схема

Метод URI Пример за JSON
POST [URI адрес на сайта]/_api/обобщаване/данни/v1.0/име на набор от таблици { "InstructionIdentifier":"", "RecommendationConfig":"" }
Име на свойството Описание
InstructionIdentifier Това място за настаняване не е задължително. За да предадете допълнителни инструкции за обобщаване, използвайте настройките на сайта, за да добавите подканата. Винаги предоставяйте името на настройката на сайта, както е било дефинирано по-рано.
RecommendationConfig Това място за настаняване не е задължително. Използвайте това свойство, за да преминете подканата, препоръчана от 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

Body:
{
"InstructionIdentifier": "Summarization/prompt/case_summary"
}

Отговор

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 Възникна грешка при обобщаване на съдържанието.

Често задавани въпроси за API за обобщаване на данни

  • Last updated on