ai.engine.register

This method adds a custom service. It also registers an engine and updates it upon repeated call. This is not the embedding location because partner's endpoint shall follow strict formats.

Parameters

Method returns ID for added engine on success.

AI type

Array with parameters:

Example

BX24.callMethod(
	'ai.engine.register',
	{
		name: 'Johnson GPT',
		code: 'johnson_gpt',
		category: 'text',
		completions_url: 'https://antonds.com/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

Attention! Script shows everything in a single code flow, as for example. You must move code strings 30-54 in a separate portion in the production mode.

Template for creating a custom endpoint can be used for customizing your own service.

Please note, script shall complete the following:

1. receive query, quickly process it, receive and add it to its internal queue.
2. be capable to return various response statuses (available in the example):
   • 200 — simple link jump;
   • 202 — if you have received the query and added to it queue;
   • 503 — service unavailable.

What to do, if all is ready - see the template.

Response standby takes specific amount of time (also specified in script), then callback becomes invalid.

Attention! In addition to response code, on success handler must return json_encode(['result' => 'OK']).

If the provider category is audio, the prompt key returns the array:

• file - link to file (be advised that it may not contain extension!),
• fields - auxiliary internal array, consisting of the following:
  • type – file's content-type, just in the very case if it doesn't have an extension (for example, "audio/ogg"),
  • prompt – auxiliary prompt for audio file (may contain principal information for successful file recognition: for example, your company name).

The provider also receives additional fields:

Example

For example, you receive (in addition to other data) three data arrays.

• prompt - contains current query, it's a simple text;
• payload_role - some text containing a specification;
• context - array (for example, also not empty).

In this case, resulting array is as follows:

[
	[
		'role' => 'system',
		'content' => $payload_role,
	],
	[
		// the complete context array, or its portion, if you want to save the query
		// but remember, it follows in a chronological order (the most recent messages are listed from below to top)
	],
	[
		'role' => 'user',
		'content' => $prompt,// its a current query and its NOT included into context
	]
];