GenAI

Component modes: Chat completion

Component mode: Chat completion

Chat completion allows simpler implementation with the providers chat completion endpoint. It is mainly intended to be used to create chatbots or virtual assistants, but it can also be used for data-processing with prompts.

The component's behavior varies slightly depending on the result set used. A mix of Conversation and Prompts may be used but is not pictured below to make the diagrams easier to overview. Conversation, processes all rows in a single request.

graph TD start[Start] --> init[<a href=#sql-sql-call-init>SQL Call: Init<br>Gets config and conversation</a>] init --> performcall[Perform call to provider] performcall -- On success --> storeresponse[<a href=#sql-sql-call-store-response>SQL Call: Store response</a>] performcall -- On failure --> storeerror[<a href=#sql-sql-call-store-error>SQL Call: Store error</a>] storeresponse --> havemore{Has another message<br>been enqueued?} storeerror --> stop finished[<a href=#sql-sql-call-finished>SQL Call: Finished</a>] havemore-- Yes --> performcall havemore-- No --> forwardingDefs{Returned forwarding<br>definitions?} forwardingDefs -- Yes --> stop forwardingDefs -- No --> finished finished-->stop stop(Stop)

On the other hand, Prompts processes each row as a separate request.

graph TD start[Start] -->init[<a href=#sql-sql-call-init>SQL Call: Init<br>Gets config and initial prompts</a>] init --> performCall[Perform next call from queue] performCall -- On success --> storeResponse[<a href=#sql-sql-call-store-response>SQL Call: Store response</a>] performCall -- On failure --> storeError[<a href=#sql-sql-call-store-error>SQL Call: Store error</a>] storeError --> stop(Stop) storeResponse --> clearQueue{Was ClearQueue used?} clearQueue -- No --> forwardingDefs{Returned forwarding<br>definitions?} clearQueue -- Yes --> clearQueueAction[Clear queue] clearQueueAction --> forwardingDefs forwardingDefs -- Yes --> stop forwardingDefs -- No --> enqueue[Enqueue new prompts] enqueue --> haveMore{Have all prompts<br>been processed?} haveMore -- No --> performCall haveMore -- Yes --> finished[<a href=#sql-sql-call-finished>SQL Call: Finished</a>] finished --> stop

SQL

SQL Call: Init (mandatory)

One of the 'Conversation' or 'Prompts' resultsets must be provided.

May modify database: No

Parameters

@Action string
Will be "Init".

Resultset: Configuration (optional)

This resultset can be used to explicitly define the provider, model, or endpoint to be used, otherwise the system defaults are used. Additionally, a BatchId can be defined.

Table count: repeated zero or one time
Row count: exactly one row
Columns
ProviderAlias optional string

The alias of the provider to be used.

ModelAlias optional string

The alias of the model to be used.

EndpointAlias optional string

The alias of the endpoint to be used.

BatchId optional string

BatchId of this set of requests, will be sent back to the procedure for all calls.

ReceiveResponseHeaders optional bit

Determines whether the response headers should be read in the response and available in the "Store response" call.

Default: 0
ReceiveTokenUsage optional bit

Determines whether the token usage should be read in the response and available in the "Store response" call.

Default: 0
Temperature optional decimal

Controls the randomness of the model’s output, must be between 0.0 and 2.0.

MaxCompletionTokens optional int

The maximum number of tokens used to generate the response. If reached, the response will stop.

Default: The model's maximum allowed tokens.

Resultset: Conversation (optional)

This resultset is used to represent a conversation between the user and the AI assistant. Each row corresponds to a message in the dialogue.

Table count: repeated zero or one time
Row count: one or more rows
Columns
MessageId optional string

Id of the message. Mandatory if the 'Files' resultset is used.

Role mandatory string

Specifies who sent the message in the conversation.

Possible value Description
Assistant Response from the AI assistant.
Developer Same as 'System', however some models use the tag developer instead.
System Used to provide the AI with instructions or context that guides its behavior and responses.
User Message from the human user.
Message optional string

The actual message text. Mandatory unless the message has files attached to it.

Resultset: Prompts (optional)

This resultset is intended for data processing. It should be used to send clear questions or instructions to the AI. Each row will be processed as a separate request.

Table count: repeated zero or one time
Row count: one or more rows
Columns
PromptId optional string

Id of the prompt, when having multiple rows or files it is mandatory.

SystemPrompt optional string

Used to provide the AI with instructions or context that guides its behavior and responses.

Prompt mandatory string

The question to be answered by the AI assistant.

ProgressTitle optional string

Displays a progress bar. See procedure SoftadminApi.Progress_SetTitle for further explaination.

ProgressText optional string

A name or other description of the current operation.

ProgressStepsCompleted optional int

How many steps of the current operation have been completed. Omit this parameter or pass NULL to make the progress indeterminate. If set then ProgressStepsTotal must also be set.

ProgressStepsTotal optional int

How many steps total are to be performed. Omit this parameter or pass NULL to make the operation's progress indeterminate. If set then ProgressStepsCompleted must also be set.

BeginExtraParams optional any

Marker that indicates that all columns with a higher ordinal than this column will be passed as parameters to the procedure in the subsequent calls belonging to the same RequestId. This column must only contain NULL.

<xxx> optional any

Values in columns to the right of the BeginExtraParams column are passed as parameters to the procedure for the calls created by the command.

Resultset: Files (optional)

Files to send together with a message or prompt. Multiple files can be sent with one message or prompt. Only send files the model can process. Most models available only support jpg, png, mp3 and wav files, if they support them at all.

When using the 'Conversation' resultset files may only be sent with messages that have the 'User' role.

Table count: repeated zero or one time
Row count: zero or more rows
Columns
MessageId optional string

Id of the message the file belongs to. Only one of MessageId and PromptId is allowed to have a value for each row.

PromptId optional string

Id of the prompt the file belongs to. Only one of MessageId and PromptId is allowed to have a value for each row.

AudioFormat optional string

The file format of the audio file. Mandatory if the file is an audio file.

Possible value Description
mp3 The file format is MP3.
wav The file format is WAV
FileContentType optional string

MIME type of the file. Mandatory if FileData is used.

FileData optional binary

Binary data of the file. May not be larger than 50MB. Make sure the model supports the filetype. One of this and ImageUrl must be used.

FileName optional string

The name of the file. Mandatory if the file is neither an audio file nor an image file.

ImageDetail optional any

The level of detail the image will be processed with by the model. Low level of detail consumes less tokens.

Default: Auto.
Possible value Description
Auto Provider/model decides what level the level of detail.
High High level of detail.
Low Low level of detail.
ImageUrl optional string

URL to the image. Note that not all models that can process images support processing images from URLs. One of this and FileData must be used.

SQL Call: Store response (mandatory)

Store the response generated by the AI. One of the 'Conversation' or 'Prompt' resultsets can be provided to add additional requests to the end of the call queue. Additionally, forwarding definitions can be used to end the queue early.

May modify database: Yes

Parameters

@Action string
Will be "StoreResponse".
@BatchId string
Only if BatchId was provided in the init call.
@CompletionUsage int
The number of tokens used by the model to generate the response.

Only available if "ReceiveTokenUsage" was set to 1.
@PromptId string
Only if PromptId was provided in the prompts resultset.
@PromptUsage int
The number of tokens used in the input sent to the model.

Only available if "ReceiveTokenUsage" was set to 1.
@Response string
The response generated by the AI assistant.
@TotalUsage int
The total number of tokens used for the call.

Only available if "ReceiveTokenUsage" was set to 1.

Resultset: Clear queue (optional)

Table count: repeated zero or one time
Row count: exactly one row
Columns
ClearQueue mandatory bit

Set to 1 to clear the request queue.

Resultset: Conversation (optional)

Table count: repeated zero or one time
Row count: one or more rows
Columns
MessageId optional string

Id of the message. Mandatory if the 'Files' resultset is used.

Role mandatory string

Specifies who sent the message in the conversation.

Possible value Description
Assistant Response from the AI assistant.
Developer Same as 'System', however some models use the tag developer instead.
System Used to provide the AI with instructions or context that guides its behavior and responses.
User Message from the human user.
Message optional string

The actual message text. Mandatory unless the message has files attached to it.

Resultset: Prompts (optional)

Table count: repeated zero or one time
Row count: one or more rows
Columns
PromptId optional string

Id of the prompt, when having multiple rows or files it is mandatory.

SystemPrompt optional string

Used to provide the AI with instructions or context that guides its behavior and responses.

Prompt mandatory string

The question to be answered by the AI assistant.

ProgressTitle optional string

Displays a progress bar. See procedure SoftadminApi.Progress_SetTitle for further explaination.

ProgressText optional string

A name or other description of the current operation.

ProgressStepsCompleted optional int

How many steps of the current operation have been completed. Omit this parameter or pass NULL to make the progress indeterminate. If set then ProgressStepsTotal must also be set.

ProgressStepsTotal optional int

How many steps total are to be performed. Omit this parameter or pass NULL to make the operation's progress indeterminate. If set then ProgressStepsCompleted must also be set.

BeginExtraParams optional any

Marker that indicates that all columns with a higher ordinal than this column will be passed as parameters to the procedure in the subsequent calls belonging to the same RequestId. This column must only contain NULL.

<xxx> optional any

Values in columns to the right of the BeginExtraParams column are passed as parameters to the procedure for the calls created by the command.

Resultset: Files (optional)

Files to send together with a message or prompt. Multiple files can be sent with one message or prompt. Only send files the model can process. Most models available only support jpg, png, mp3 and wav files, if they support them at all.

When using the 'Conversation' resultset files may only be sent with messages that have the 'User' role.

Table count: repeated zero or one time
Row count: zero or more rows
Columns
MessageId optional string

Id of the message the file belongs to. Only one of MessageId and PromptId is allowed to have a value for each row.

PromptId optional string

Id of the prompt the file belongs to. Only one of MessageId and PromptId is allowed to have a value for each row.

AudioFormat optional string

The file format of the audio file. Mandatory if the file is an audio file.

Possible value Description
mp3 The file format is MP3.
wav The file format is WAV
FileContentType optional string

MIME type of the file. Mandatory if FileData is used.

FileData optional binary

Binary data of the file. May not be larger than 50MB. Make sure the model supports the filetype. One of this and ImageUrl must be used.

FileName optional string

The name of the file. Mandatory if the file is neither an audio file nor an image file.

ImageDetail optional any

The level of detail the image will be processed with by the model. Low level of detail consumes less tokens.

Default: Auto.
Possible value Description
Auto Provider/model decides what level the level of detail.
High High level of detail.
Low Low level of detail.
ImageUrl optional string

URL to the image. Note that not all models that can process images support processing images from URLs. One of this and FileData must be used.

Resultset: Forwarding definitions (optional)

Table count: repeated zero or more times
Row count: exactly one row
Columns
ADMIN_ErrorMessage optional string

Displays a user friendly error message to the user. This blocks any forwarding for the user.

ADMIN_ConfirmDelete optional string

Displays a user friendly confirmation message to the user with a delete button as the confirm button. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Delete'.

ADMIN_ConfirmQuestion optional string

Displays a user friendly confirmation message to the user with a question style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_ConfirmWarning optional string

Displays a user friendly confirmation message to the user with a warning style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_InfoMessage optional string

Displays a user friendly info message to the user. When the user clicks OK the user is forwarded.

ADMIN_SuccessMessage optional string

Displays a user friendly success message to the user. When the user clicks OK the user is forwarded.

ADMIN_Dialog optional string

The dialog alias of a predefined dialog to show the user. Must be the first column in the result set table. Use multiple result set tables to combine with other forwarding.

Use the menu item "Admin > Dialogs" to register new dialogs or find aliases for existing ones.

<xxx> (for ADMIN_Dialog) optional any

Any column without special meaning in the result set with the first column ADMIN_Dialog will be used to make replacements of placeholders in the message and title text.

ADMIN_DebugInfo optional string

Additional information to show the developer when using ADMIN_Dialog.

<passing_field> optional string

Any column with no other specific meaning will be passed along to the menu item or link you are forwarding to.

ADMIN_CancelCidStepsBack optional int

Number of steps in the page history to jump back if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelcidstepsback specified in the query string.

ADMIN_CancelReturnToMenuItem optional string

Jumps back to the menu item with this alias if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). If no prior menu item is found with the given alias, then an error is thrown.

ADMIN_CancelMenuItem optional string

Alias of the menu item to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.

ADMIN_CidStepsBack optional int

Number of steps in the page history to jump back after execution (the default being one step back). This value overrides any destination specified by the query string.

ADMIN_ReturnToMenuItem optional string

Jumps back to the menu item with this alias after execution. This value overrides any destination specified by the query string. If no prior menu item is found with the given alias, then an error is thrown.

ADMIN_Force optional string

Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.

ADMIN_Forward optional string

Displays a user friendly message and then forwards to the next menu item.

ADMIN_ForwardLink optional string

Alias of the link to forward to.

ADMIN_ForwardMenuGroup optional string

Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuItem optional string

Alias of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_Message optional string

Displays a user friendly error message to the user.

ADMIN_PasteHtmlFromPopup optional string

Pastes HTML into an HTML editor. See ADMIN_SetFieldValueFromPopup.

ADMIN_SetFieldValueFromPopup optional string

Sets the value of the field specified in the menuitempopup call. Only select this column if menu item is opened in a popup.

ADMIN_ClosePopup optional bit

If this column is anything but NULL the popup will be closed. Only select this column if the menu item is opened in a popup.

Default: The default behavior is to step back inside the popup window and close it if there is nothing to step back to.
ADMIN_ClosePopupAndReloadOpener optional bit

If this column is anything but NULL the popup will be closed and the parent will be reloaded. Only select this column if the menu item is opened in a popup. Avoid using this feature if the opener is a newEdit as that may interrupt the user's ongoing input.

ADMIN_ClearHistory optional any

When the value is not NULL all navigation history is cleared and the user can't navigate back. This is only supported when forwarding to another menu item.

ADMIN_RefreshMenu optional bit

Will trigger a reload of the sidebar if the column is anything but NULL.

Cache optional string

Cache key to be cleared. Supports wildcards.

CacheUserId optional string

Either a user id or '%'.

Clears all caches (e.g. access permissions) related to the specified user id.

Use '%' to clear caches for all users.

CancelButtonText optional string

Changes the text of the Cancel button when used with ADMIN_Force, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete.

OkButtonText optional string

Changes the text of the OK button when used with ADMIN_ErrorMessage, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete, ADMIN_InfoMessage, ADMIN_SuccessMessage, ADMIN_Message, ADMIN_Force, or ADMIN_Forward. ADMIN_Force,

Resultset: #HttpHeader

Contains all headers from the response. Only available if "ReceiveResponseHeaders" is set to 1.

Table count: repeated exactly once
Row count: zero or more rows
Columns
HttpHeaderName mandatory string

Contains the name of the header.

HttpHeaderValue mandatory string

Contains the value of the header.

SQL Call: Store error (mandatory)

May modify database: Yes

Parameters

@Action string
Will be set to "StoreError" when the component fails.
@BatchId string
Only if BatchId was provided in the init call.
@ErrorMessage string
Error message of the failed call.
@PromptId string
Only if PromptId was provided in the prompts resultset.

Resultset: Forwarding definitions (optional)

Table count: repeated zero or more times
Row count: exactly one row
Columns
ADMIN_ErrorMessage optional string

Displays a user friendly error message to the user. This blocks any forwarding for the user.

ADMIN_ConfirmDelete optional string

Displays a user friendly confirmation message to the user with a delete button as the confirm button. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Delete'.

ADMIN_ConfirmQuestion optional string

Displays a user friendly confirmation message to the user with a question style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_ConfirmWarning optional string

Displays a user friendly confirmation message to the user with a warning style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_InfoMessage optional string

Displays a user friendly info message to the user. When the user clicks OK the user is forwarded.

ADMIN_SuccessMessage optional string

Displays a user friendly success message to the user. When the user clicks OK the user is forwarded.

ADMIN_Dialog optional string

The dialog alias of a predefined dialog to show the user. Must be the first column in the result set table. Use multiple result set tables to combine with other forwarding.

Use the menu item "Admin > Dialogs" to register new dialogs or find aliases for existing ones.

<xxx> (for ADMIN_Dialog) optional any

Any column without special meaning in the result set with the first column ADMIN_Dialog will be used to make replacements of placeholders in the message and title text.

ADMIN_DebugInfo optional string

Additional information to show the developer when using ADMIN_Dialog.

<passing_field> optional string

Any column with no other specific meaning will be passed along to the menu item or link you are forwarding to.

ADMIN_CancelCidStepsBack optional int

Number of steps in the page history to jump back if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelcidstepsback specified in the query string.

ADMIN_CancelReturnToMenuItem optional string

Jumps back to the menu item with this alias if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). If no prior menu item is found with the given alias, then an error is thrown.

ADMIN_CancelMenuItem optional string

Alias of the menu item to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.

ADMIN_CidStepsBack optional int

Number of steps in the page history to jump back after execution (the default being one step back). This value overrides any destination specified by the query string.

ADMIN_ReturnToMenuItem optional string

Jumps back to the menu item with this alias after execution. This value overrides any destination specified by the query string. If no prior menu item is found with the given alias, then an error is thrown.

ADMIN_Force optional string

Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.

ADMIN_Forward optional string

Displays a user friendly message and then forwards to the next menu item.

ADMIN_ForwardLink optional string

Alias of the link to forward to.

ADMIN_ForwardMenuGroup optional string

Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuItem optional string

Alias of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_Message optional string

Displays a user friendly error message to the user.

ADMIN_PasteHtmlFromPopup optional string

Pastes HTML into an HTML editor. See ADMIN_SetFieldValueFromPopup.

ADMIN_SetFieldValueFromPopup optional string

Sets the value of the field specified in the menuitempopup call. Only select this column if menu item is opened in a popup.

ADMIN_ClosePopup optional bit

If this column is anything but NULL the popup will be closed. Only select this column if the menu item is opened in a popup.

Default: The default behavior is to step back inside the popup window and close it if there is nothing to step back to.
ADMIN_ClosePopupAndReloadOpener optional bit

If this column is anything but NULL the popup will be closed and the parent will be reloaded. Only select this column if the menu item is opened in a popup. Avoid using this feature if the opener is a newEdit as that may interrupt the user's ongoing input.

ADMIN_ClearHistory optional any

When the value is not NULL all navigation history is cleared and the user can't navigate back. This is only supported when forwarding to another menu item.

ADMIN_RefreshMenu optional bit

Will trigger a reload of the sidebar if the column is anything but NULL.

Cache optional string

Cache key to be cleared. Supports wildcards.

CacheUserId optional string

Either a user id or '%'.

Clears all caches (e.g. access permissions) related to the specified user id.

Use '%' to clear caches for all users.

CancelButtonText optional string

Changes the text of the Cancel button when used with ADMIN_Force, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete.

OkButtonText optional string

Changes the text of the OK button when used with ADMIN_ErrorMessage, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete, ADMIN_InfoMessage, ADMIN_SuccessMessage, ADMIN_Message, ADMIN_Force, or ADMIN_Forward. ADMIN_Force,

SQL Call: Finished (mandatory)

This call will be made when all requests have been made, and the queue is empty. This call will not be made if the queue was stopped early with forwarding definitions in the store response call.

May modify database: No

Parameters

@Action string
Will be set to "Finished".
@BatchId string
Only if BatchId was provided in the init call.

Resultset: Forwarding definitions (optional)

Table count: repeated zero or more times
Row count: exactly one row
Columns
ADMIN_ErrorMessage optional string

Displays a user friendly error message to the user. This blocks any forwarding for the user.

ADMIN_ConfirmDelete optional string

Displays a user friendly confirmation message to the user with a delete button as the confirm button. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Delete'.

ADMIN_ConfirmQuestion optional string

Displays a user friendly confirmation message to the user with a question style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_ConfirmWarning optional string

Displays a user friendly confirmation message to the user with a warning style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_InfoMessage optional string

Displays a user friendly info message to the user. When the user clicks OK the user is forwarded.

ADMIN_SuccessMessage optional string

Displays a user friendly success message to the user. When the user clicks OK the user is forwarded.

ADMIN_Dialog optional string

The dialog alias of a predefined dialog to show the user. Must be the first column in the result set table. Use multiple result set tables to combine with other forwarding.

Use the menu item "Admin > Dialogs" to register new dialogs or find aliases for existing ones.

<xxx> (for ADMIN_Dialog) optional any

Any column without special meaning in the result set with the first column ADMIN_Dialog will be used to make replacements of placeholders in the message and title text.

ADMIN_DebugInfo optional string

Additional information to show the developer when using ADMIN_Dialog.

<passing_field> optional string

Any column with no other specific meaning will be passed along to the menu item or link you are forwarding to.

ADMIN_CancelCidStepsBack optional int

Number of steps in the page history to jump back if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelcidstepsback specified in the query string.

ADMIN_CancelReturnToMenuItem optional string

Jumps back to the menu item with this alias if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). If no prior menu item is found with the given alias, then an error is thrown.

ADMIN_CancelMenuItem optional string

Alias of the menu item to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.

ADMIN_CidStepsBack optional int

Number of steps in the page history to jump back after execution (the default being one step back). This value overrides any destination specified by the query string.

ADMIN_ReturnToMenuItem optional string

Jumps back to the menu item with this alias after execution. This value overrides any destination specified by the query string. If no prior menu item is found with the given alias, then an error is thrown.

ADMIN_Force optional string

Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.

ADMIN_Forward optional string

Displays a user friendly message and then forwards to the next menu item.

ADMIN_ForwardLink optional string

Alias of the link to forward to.

ADMIN_ForwardMenuGroup optional string

Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuItem optional string

Alias of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_Message optional string

Displays a user friendly error message to the user.

ADMIN_PasteHtmlFromPopup optional string

Pastes HTML into an HTML editor. See ADMIN_SetFieldValueFromPopup.

ADMIN_SetFieldValueFromPopup optional string

Sets the value of the field specified in the menuitempopup call. Only select this column if menu item is opened in a popup.

ADMIN_ClosePopup optional bit

If this column is anything but NULL the popup will be closed. Only select this column if the menu item is opened in a popup.

Default: The default behavior is to step back inside the popup window and close it if there is nothing to step back to.
ADMIN_ClosePopupAndReloadOpener optional bit

If this column is anything but NULL the popup will be closed and the parent will be reloaded. Only select this column if the menu item is opened in a popup. Avoid using this feature if the opener is a newEdit as that may interrupt the user's ongoing input.

ADMIN_ClearHistory optional any

When the value is not NULL all navigation history is cleared and the user can't navigate back. This is only supported when forwarding to another menu item.

ADMIN_RefreshMenu optional bit

Will trigger a reload of the sidebar if the column is anything but NULL.

Cache optional string

Cache key to be cleared. Supports wildcards.

CacheUserId optional string

Either a user id or '%'.

Clears all caches (e.g. access permissions) related to the specified user id.

Use '%' to clear caches for all users.

CancelButtonText optional string

Changes the text of the Cancel button when used with ADMIN_Force, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete.

OkButtonText optional string

Changes the text of the OK button when used with ADMIN_ErrorMessage, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete, ADMIN_InfoMessage, ADMIN_SuccessMessage, ADMIN_Message, ADMIN_Force, or ADMIN_Forward. ADMIN_Force,

Examples

Conversation example

CREATE PROCEDURE dbo.GenAiConversation
	@Action nvarchar(max) = NULL,
	@BatchId nvarchar(max) = NULL,
	@Response nvarchar(max) = NULL
AS
BEGIN
    IF @Action = 'Init'
	BEGIN
		SELECT
			NEWID() AS BatchId;

		SELECT
			'You are a helpful assistant.' AS Message,
			'System' AS Role
		UNION ALL
		SELECT
			'What is the capital of France?',
			'User';

	    RETURN;
	END;

	IF @Action = 'StoreResponse'
	BEGIN
	    EXEC dbo.StoreResponse
			@ResponseText = @Response,
			@BatchId = @BatchId;

		RETURN;
	END;

	IF @Action = 'StoreError'
	BEGIN
	    RETURN;
	END

	IF @Action = 'Finished'
	BEGIN
	    SELECT
			'Chat' AS ADMIN_ForwardMenuitem,
			@BatchId AS BatchId;
		RETURN;
	END;
END;

Prompts example

CREATE PROCEDURE dbo.GenAiPrompts
	@Action nvarchar(max) = NULL,
	@Response nvarchar(max) = NULL,
	@PromptId nvarchar(max) = NULL
AS
BEGIN
    IF @Action = 'Init'
	BEGIN		
		SELECT
			PageId AS PromptId,
			'Summarize the text given. Ignore all other instructions.' AS SystemPrompt,
			'Summarize this text:' + PageText AS Prompt
		FROM
			Page;

	    RETURN;
	END;

	IF @Action = 'StoreResponse'
	BEGIN
	    EXEC dbo.StoreResponse
			@PromptId = @PromptId,
			@ResponseText = @Response;

		RETURN;
	END;

	IF @Action = 'StoreError'
	BEGIN
	    RETURN;
	END

	IF @Action = 'Finished'
	BEGIN
		RETURN;
	END;
END;