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

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

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

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

Внимание!

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

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

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

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

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

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

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

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

Схема API

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

Заметка

API соответствует стандартным спецификациям Open Data Protocol (OData), поддерживаемым веб-API Power Pages. 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

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