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

Обзор API-интерфейса резюмирования данных (предварительная версия)

  • Статья

[Данная статья посвящена предварительному выпуску и может быть изменена.]

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

Внимание!

  • Это предварительная версия функции.
  • Предварительные версии функций не предназначены для использования в производственной среде, а их функциональность может быть ограничена. Для этих функций действуют дополнительные условия использования и они доступны перед официальным выпуском, чтобы клиенты могли досрочно получить доступ и предоставить отзывы.

Предварительные требования

  • Необходимо включить параметры сайта для веб-API.
  • Для создания сводок доступны только таблицы, поддерживаемые Power Pages для веб-API. Дополнительные сведения о Power Pages веб-API см. в разделе Обзор веб-API.
  • Эта функция недоступна в регионах правительственного облака сообщества (GCC), правительственного облаке сообщества High (GCC High) и министерства обороны (DoD).

Параметры сайта

Включите страницы в веб-API и задайте следующие параметры сайта для функции API создания сводок.

Имя настройки сайта Description
Резюмирование/Данные/Включить Включите или отключите функцию резюмирования.
Значение по умолчанию: False
Допустимые значения: True, False
Резюмирование/запрос/{any_identifier}

Используйте эти параметры для предоставления инструкций по созданию сводок.
Тип: строка

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

Схема API

Способ URI Пример JSON
POST [URI сайта]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Имя свойства Description
InstructionIdentifier Это необязательное свойство. Если вы хотите передать какие-либо другие инструкции для создания сводок, используйте параметры сайта, чтобы добавить запрос. Всегда следует указывать имя параметра сайта в том виде, в котором оно было определено ранее.
RecommendationConfig Это необязательное свойство. Если вы хотите передать запрос, рекомендуемый API-интерфейсом создания сводок, используйте это свойство для его передачи. Значение должно быть хешировано и не изменено.

Заметка

API соответствует стандартным спецификациям Open Data Protocol (OData), поддерживаемым Power Pages веб-API. API-интерфейс создания сводок поддерживает все операции чтения, поддерживаемые веб-API Power Pages.

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"
}

Отклик

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 формирования сводок.

Код состояния Код ошибки Error message
400 90041001 Функции генеративного ИИ отключены
400 90041003 Создание сводки данных отключено для этого сайта. Включите с помощью параметра сайта.
400 90041004 Длина содержимого превышает ограничение
400 90041005 Не найдены записи для создания сводки
400 90041006 Возникла ошибка при создание сводки содержимого.

Вопросы и ответы об API-интерфейсе создании сводок данных