ai.engine.register

ai.engine.register

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

Параметры

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

Тип AI

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

Пример

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 необходимо вынести строчки кода 30-54 в отдельную часть.

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

Обратите внимание, скрипт должен:

1. принять запрос, отработать его быстро, принять и добавить в свою внутреннюю очередь.
2. уметь возвращать различные статусы ответа (есть в примере):
   • 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,// это текущий запрос, и он НЕ входит в контекст
	]
];