%Embedding.Config
persistent class %Embedding.Config extends %Library.Persistent [ Final ]
SQL Table Name: %Embedding.Config
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 tableProperty Inventory
Method Inventory
Properties
property Configuration as %String) [ Required ];
JSON formatted string that contains class specific configuration details. Refer to the Embedding Class's IsValidConfig for more information
Property methods: ConfigurationDisplayToLogical(), ConfigurationGet(), ConfigurationGetStored(), ConfigurationIsValid(), ConfigurationLogicalToDisplay(), ConfigurationLogicalToOdbc(), ConfigurationNormalize(), ConfigurationSet()
property Description as %String (MAXLEN = 5000);
Optional description of configuration
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property EmbeddingClass as %String (MAXLEN = 250) [ Required ];
Name of %Embedding class that extends %Embedding.Interface. Eg. %Embedding.SentenceTransformers
Property methods: EmbeddingClassDisplayToLogical(), EmbeddingClassGet(), EmbeddingClassGetStored(), EmbeddingClassIsValid(), EmbeddingClassLogicalToDisplay(), EmbeddingClassLogicalToOdbc(), EmbeddingClassNormalize(), EmbeddingClassSet()
property Name as %String (MAXLEN = 100) [ Required ];
Name of configuration, to be referenced when using the EMBEDDING SQL function or the %Embedding datatype
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property VectorLength as %Integer;
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.
Property methods: VectorLengthCompute(), VectorLengthDisplayToLogical(), VectorLengthGet(), VectorLengthGetStored(), VectorLengthIsValid(), VectorLengthLogicalToDisplay(), VectorLengthNormalize(), VectorLengthSQLCompute(), VectorLengthSet(), VectorLengthSetT()
Methods
classmethod VectorLengthComputation(cols As %Library.PropertyHelper) as %String
Indexes
index (NameIndex on Name) [IdKey, Type = key];
Index methods: NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()
Triggers
trigger ValidateConfig (BEFORE event INSERT/UPDATE);
Inherited Members
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InitExtentData()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
Storage
Storage Model: Storage (%Embedding.Config)
^rINDEXSQL("Embedding")(ID) |
= | Configuration
EmbeddingClass
VectorLength
Description
|