Embedding

Gets text embeddings from an embedding model. Embeddings capture the semantic meaning of text and can be used for semantic search, categorization, or recommendation.

Embeddings can be stored in a database column using either the varchar, nvarchar, or the vector data type.

Component modes: Single | Batch

Component mode: Batch

The batch mode is designed to retrieve the embedding for multiple texts. A list of IDs are retrieved in the "Init" call which are then used to retrieve the text data in the "Get text by id" call.

graph TD start[Start] --> init[<a href=#sql-sql-call-init>SQL Call: Init<br>Gets config and text</a>] init -- Procedure returned requests --> getText[<a href=#sql-sql-call-get-text-by-id>SQL Call: Get text by id</a>] getText --> performcall[Perform call to provider] performcall -- On failure --> storeerror[<a href=#sql-sql-call-store-error>SQL Call: Store error</a>] performcall -- On success --> storeembedding[<a href=#sql-sql-call-store-embedding>SQL Call: Store embedding</a>] storeerror --> emptyQueue{Was ClearQueue used?} emptyQueue -- Yes --> finished emptyQueue -- No --> queueEmpty storeembedding --> queueEmpty{Are there requests left?} queueEmpty -- No --> finished queueEmpty -- Yes --> getText init -- Procedure returned no request --> finished[<a href=#sql-sql-call-finished>SQL Call: Finish</a>] finished --> stop stop(Stop)

Component settings

Request timeout
Timeout in seconds for each web service request.

SQL

SQL Call: Init (mandatory)

May modify database: No

Parameters

@Action string
Set to 'Init' for this call.

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.

Dimensions optional int

The number of dimensions of the embedding vectors. Not all models support variable dimension output. Larger vectors impact performance. It is often enough to use 256 or 512 dimensions.

ReceiveResponseHeaders optional bit

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

Default: 0.
ReceiveTokenUsage optional bit

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

Default: 0.

Resultset: Id values

A table containing id values. "Get text by id" will be called once for each id in the table. Each id value will result in a separate request to the provider.

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

Id that will be sent back to the procedure in the "Get text by id" call.

ProgressTitle optional string

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

ProgressText optional string

A name or other description of the current operation.

ProgressStepsTotal optional string

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.

ProgressStepsCompleted optional string

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.

SQL Call: Get text by id (mandatory)

May modify database: No

Parameters

@Action string
Set to 'GetText' for this call.
@BatchId string
Only if BatchId was provided in the "Init" call.
@Id string
The ID of the current text to fetch.

Resultset: Text

Table count: repeated exactly once
Row count: exactly one row
Columns
Text mandatory string

Text to calculate the embedding vector for.

SQL Call: Store embedding (mandatory)

Store the embedding generated by the model.

May modify database: Yes

Parameters

@Action string
Set to 'StoreEmbedding' for this call.
@BatchId string
Only if BatchId was provided in the "Init" call.
@Embedding string
The embedding generated by the model.
@Id string
The ID of the text embedding.
@PromptUsage int
The number of tokens used in the input sent to the model.

Only available if "ReceiveTokenUsage" was set to 1.
@TotalUsage int
The total number of tokens used for the call.

Only available if "ReceiveTokenUsage" was set to 1.

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
Set to 'StoreError' for this call.
@BatchId string
Only if BatchId was provided in the "Init" call.
@ErrorMessage string
Error message of the failed call.
@Id string
The ID of the document that caused the error.

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.

SQL Call: Finished (mandatory)

May modify database: No

Parameters

@Action string
Set to 'Finished' for this 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 pe passed along to the menu item 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: Validate parameters

Allows you to validate the SQL parameters before any other SQL is run in the component. This call is only made if the SQL is a stored procedure and Validate parameters is checked.

May modify database: No

Parameters

@Force bit
Set to 1 if the last call to validate parameters used admin_force and the user clicked OK in the OK/Cancel dialog.
@ValidateParams bit
Set to 1 when this call is made.

Resultset: Messages (optional)

Table count: repeated zero or one time
Row count: zero or one row
Columns
ADMIN_Force optional string
Message asking the end user to confirm their parameters.
ADMIN_Message optional string
Message explaining why the parameters are rejected.

Custom access control and logging

SQL Call: Custom access control and logging

Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.

Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.

The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.

If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.

May modify database: Yes

Resultset: Access permissions

Return whether the user is allowed to visit the menu item with the current parameters.
Table count: repeated exactly once
Row count: exactly one row
Columns
GrantAccess mandatory bit
1 if the user is allowed to view the menu item, 0 if the user should not be allowed to view the menu item.

If 0 then an error will be logged as the user should not have been able to reach the menu item with the given parameters in the first place.