Споделяне чрез

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

  • Статия

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

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

Важно

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

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

  • Трябва да разрешите настройките на сайта за уеб API.
  • Само таблици, които се поддържат Power Pages за уеб API, са налични за обобщаване. Научете повече за Power Pages уеб API в Общ преглед на уеб API.
  • Функцията не е налична в региони на Government Community Cloud (GCC), Government Community Cloud – High (GCC High) или Министерство на отбраната (DoD).

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

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

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

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

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

API схема

Метод URI Пример за JSON
POST [URI адрес на сайта]/_api/обобщаване/данни/v1.0/име на набор от таблици { "InstructionIdentifier":"", "RecommendationConfig":"" }
Име на свойството Описание
InstructionIdentifier Това място за настаняване не е задължително. Ако искате да предадете други инструкции за обобщаване, използвайте настройките на сайта, за да добавите подканата. Винаги трябва да предоставяте името на настройката на сайта, както е било дефинирано по-рано.
RecommendationConfig Това място за настаняване не е задължително. Ако искате да предадете подканата, препоръчана от API за обобщаване, използвайте това свойство, за да я предадете. Стойността трябва да бъде хеширана и да не се променя.

Бележка

API следва стандартните спецификации на Open Data Protocol (OData), които Web Power Pages API поддържа. API за обобщаване поддържа всички операции за четене, които уеб Power Pages API поддържа.

Sample

Обобщете вида на случая, темата, описанието и историята на случая, като се съсредоточите върху ключови подробности и критична информация.

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 за обобщаване.

Код на състоянието Код на грешка Съобщение за грешка
400 90041001 Генеративните функции на AI са деактивирани
400 90041003 Обобщаването на данните е деактивирано за този сайт. Активирайте с помощта на настройката на сайта.
400 90041004 Дължината на съдържанието надвишава ограничението
400 90041005 Не са намерени записи за обобщаване
400 90041006 Възникна грешка при обобщаване на съдържанието.

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