При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Зарегистрировать сервис ai.engine.register», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Зарегистрировать сервис ai.engine.register

Тут может не хватать некоторых данных — дополним в ближайшее время

• нужны правки под стандарт написания
• не указаны типы параметров
• не указана обязательность параметров
• отсутствуют примеры
• отсутствует ответ в случае успеха
• отсутствует ответ в случае ошибки
• не прописаны ссылки на несозданные ещё страницы.

> Scope: ai_admin
>
> Кто может выполнять метод: администратор

REST-метод для добавления пользовательского сервиса. Метод регистрирует engine, при повторном вызове обновляет его. Это не совсем место встройки, так как endpoint партнера должен следовать четким форматам.

Метод в случае успеха вернёт ID добавленного engine.

Тип AI

Массив параметров:

Практические примеры использования в коде

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'ai.engine.register',
    		{
    			name: 'Ivanov GPT',
    			code: 'ivanov_gpt',
    			category: 'text',
    			completions_url: 'https://antonds.ru/ai/aul/completions/',
    			settings: {
    				code_alias: 'ChatGPT',
    				model_context_type: 'token',
    				model_context_limit: 16*1024,
    			},
    		}
    	);
    	
    	const result = response.getData().result;
    	console.info(result);
    }
    catch( error )
    {
    	console.error(error);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'ai.engine.register',
                [
                    'name'            => 'Ivanov GPT',
                    'code'            => 'ivanov_gpt',
                    'category'        => 'text',
                    'completions_url' => 'https://antonds.ru/ai/aul/completions/',
                    'settings'        => [
                        'code_alias'          => 'ChatGPT',
                        'model_context_type'  => 'token',
                        'model_context_limit' => 16 * 1024,
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error registering AI engine: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        'ai.engine.register',
        {
            name: 'Ivanov GPT',
            code: 'ivanov_gpt',
            category: 'text',
            completions_url: 'https://antonds.ru/ai/aul/completions/',
            settings: {
                code_alias: 'ChatGPT',
                model_context_type: 'token',
                model_context_limit: 16*1024,
            },
        },
        function(result)
        {
            if(result.error())
            {
                console.error(result.error());
            }
            else
            {
                console.info(result.data());
            }
        }
    );

Endpoint

В скрипте все в едином потоке кода, это для примера. В режиме production необходимо вынести строчки кода в отдельную часть.

Шаблон для создания пользовательского endpoint можно использовать для кастомизации собственного сервиса.

Важные моменты:

1. Скрипт должен принять запрос, отработать его быстро, принять и добавить в свою внутреннюю очередь.
2. Сервис с типом «image» должен отправлять асинхронные запросы.
3. Уметь возвращать различные статусы ответа (есть в примере):

• 200 — обычный переход по ссылке;
• 202 — если вы приняли запрос и добавили в очередь;
• 503 — если сервис недоступен.

Ответ ожидается в течение определенного времени, потом колбек становится невалидным.

Помимо кода ответа, в случае успешной генерации, обработчик должен обязательно возвращать json_encode(['result' => 'OK']).

Когда вы работаете с категорией провайдера audio, в ключе prompt вы получаете массив, который включает в себя следующие элементы:

• file: Ссылка на файл. Важно отметить, что файл может быть без расширения.
• fields: Вспомогательный внутренний массив, который содержит:
• type: Content-type файла, что особенно важно, если файл без расширения (например, «audio/ogg»).
• prompt: Вспомогательный промпт для аудио-файла, который может содержать ключевую информацию для помощи в распознавании файла, например, название вашей компании.

В ответе провайдеру уходят так же дополнительные поля:

\ — Обязательные параметры

Пример

Допустим, к вам приходит (помимо прочей информации) три массива данных.

• prompt — содержит текущий запрос, это просто текст;
• payload_role — некий текст, содержащий инструкции;
• context — массив (допустим, тоже не пустой).

В этом случае, результирующий массив мы получаем как:

[
    [
        "role": "system",
        "content": "$payload_role"
    ],
    [
        // весь массив context, или его часть, если вы хотите сэкономить запрос
        // но помните, что он идет в хронологическом порядке (снизу самые последние сообщения)
    ],
    [
        "role": "user",
        "content": "$prompt" // это текущий запрос, и он НЕ входит в контекст
    ]
]