Skip to main content

%Embedding.Config

Class %Embedding.Config Extends %Persistent [ Final ]

This class stores various Embedding endpoints as a table. To use the EMBEDDING SQL function or the %Embedding datatype, users need to first insert a configuration into this table

Properties​

Name​

Property Name As %String(MAXLEN = 100) [ Required ];

Name of configuration, to be referenced when using the EMBEDDING SQL function or the %Embedding datatype

Configuration​

Property Configuration As %String(MAXLEN = "") [ Required ];

JSON formatted string that contains class specific configuration details. Refer to the Embedding Class's IsValidConfig for more information

EmbeddingClass​

Property EmbeddingClass As %String(MAXLEN = 250) [ Required ];

Name of %Embedding class that extends %Embedding.Interface. Eg. %Embedding.SentenceTransformers

VectorLength​

Property VectorLength As %Integer [ SqlComputed, SqlComputeOnChange = %%UPDATE ];

Length of embedding vector. If using %Embedding.SentenceTransformers, this can be left empty and will be automatically computed. If not, users must provide the vector length.

Description​

Property Description As %String(MAXLEN = 5000);

Optional description of configuration

Triggers​

ValidateConfig​

Trigger ValidateConfig [ Event = INSERT/UPDATE ]

Methods​

VectorLengthComputation​

ClassMethod VectorLengthComputation(cols As %Library.PropertyHelper) As %String