Как использовать метод SDK ai.engine.register в Битрикс24

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Как использовать метод SDK ai.engine.register в Битрикс24». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Описание метода SDK ai.engine.register

Метод ai.engine.register является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. REST method for adding a custom service. This method registers an engine and updates it upon subsequent calls. This is not quite an embedding location, as the endpoint of the partner must adhere to strict formats.

Параметры и сигнатура метода

В рамках SDK метод объявлен в пространстве имен \Bitrix24\SDK\Services\AI\Engine\Service\Engine со следующей сигнатурой:

public function register(
      string $name,
      string $code,
      EngineCategory $category,
      string $completionsUrl,
      EngineSettings $settings
  ): Result

Пример использования на PHP

Ниже представлен готовый практический пример интеграции с использованием Bitrix24 PHP SDK. Этот пример показывает, как правильно инициализировать сервис-билдер и вызвать метод register:

<?php
declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// Инициализация официального Bitrix24 PHP SDK через входящий вебхук
$webhookUrl = 'https://your-portal.bitrix24.ru/rest/1/your-webhook-code/';
$serviceBuilder = ServiceBuilderFactory::createServiceBuilderFromWebhook($webhookUrl);

try {
    // Подготовка параметров для вызова метода ai.engine.register
    $name = "пример_значения";
    $code = "пример_значения";
    $category = new \Bitrix24\SDK\Services\AI\Engine\Service\EngineCategory();
    $completionsUrl = "пример_значения";
    $settings = new \Bitrix24\SDK\Services\AI\Engine\Service\EngineSettings();

    // Выполнение запроса через Scope getAiAdminScope и сервис engine
    $result = $serviceBuilder->getAiAdminScope()->engine()->register(
          $name,
          $code,
          $category,
          $completionsUrl,
          $settings
      );

    // Обработка полученных данных
    print_r($result->getResponseData()->getResult());

} catch (\Throwable $exception) {
    // Обработка исключений при интеграции
    echo "Ошибка при выполнении метода ai.engine.register: " . $exception->getMessage();
}

Полезные ссылки

• Официальная REST API документация: https://apidocs.bitrix24.com/api-reference/ai/ai-engine-register.html
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk