@memberjunction/core-entities 5.21.0 → 5.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12854,17 +12854,17 @@ export const MJEntityDocumentSchema = z.object({
12854
12854
  * * SQL Data Type: nvarchar(250)`),
12855
12855
  TypeID: z.string().describe(`
12856
12856
  * * Field Name: TypeID
12857
- * * Display Name: Type ID
12857
+ * * Display Name: Type
12858
12858
  * * SQL Data Type: uniqueidentifier
12859
12859
  * * Related Entity/Foreign Key: MJ: Entity Document Types (vwEntityDocumentTypes.ID)`),
12860
12860
  EntityID: z.string().describe(`
12861
12861
  * * Field Name: EntityID
12862
- * * Display Name: Entity ID
12862
+ * * Display Name: Entity
12863
12863
  * * SQL Data Type: uniqueidentifier
12864
12864
  * * Related Entity/Foreign Key: MJ: Entities (vwEntities.ID)`),
12865
12865
  VectorDatabaseID: z.string().describe(`
12866
12866
  * * Field Name: VectorDatabaseID
12867
- * * Display Name: Vector Database ID
12867
+ * * Display Name: Vector Database
12868
12868
  * * SQL Data Type: uniqueidentifier
12869
12869
  * * Related Entity/Foreign Key: MJ: Vector Databases (vwVectorDatabases.ID)`),
12870
12870
  Status: z.union([z.literal('Active'), z.literal('Inactive')]).describe(`
@@ -12878,12 +12878,12 @@ export const MJEntityDocumentSchema = z.object({
12878
12878
  * * Inactive`),
12879
12879
  TemplateID: z.string().describe(`
12880
12880
  * * Field Name: TemplateID
12881
- * * Display Name: Template ID
12881
+ * * Display Name: Template
12882
12882
  * * SQL Data Type: uniqueidentifier
12883
12883
  * * Related Entity/Foreign Key: MJ: Templates (vwTemplates.ID)`),
12884
12884
  AIModelID: z.string().describe(`
12885
12885
  * * Field Name: AIModelID
12886
- * * Display Name: AIModel ID
12886
+ * * Display Name: AI Model
12887
12887
  * * SQL Data Type: uniqueidentifier
12888
12888
  * * Related Entity/Foreign Key: MJ: AI Models (vwAIModels.ID)`),
12889
12889
  PotentialMatchThreshold: z.number().describe(`
@@ -12900,34 +12900,49 @@ export const MJEntityDocumentSchema = z.object({
12900
12900
  * * Description: Value between 0 and 1 that determines what is considered an absolute matching record. Value must be >= PotentialMatchThreshold. This is primarily used for duplicate detection but can be used for other applications as well where matching is relevant.`),
12901
12901
  __mj_CreatedAt: z.date().describe(`
12902
12902
  * * Field Name: __mj_CreatedAt
12903
- * * Display Name: __mj _Created At
12903
+ * * Display Name: Created At
12904
12904
  * * SQL Data Type: datetimeoffset
12905
12905
  * * Default Value: getutcdate()`),
12906
12906
  __mj_UpdatedAt: z.date().describe(`
12907
12907
  * * Field Name: __mj_UpdatedAt
12908
- * * Display Name: __mj _Updated At
12908
+ * * Display Name: Updated At
12909
12909
  * * SQL Data Type: datetimeoffset
12910
12910
  * * Default Value: getutcdate()`),
12911
+ VectorIndexID: z.string().nullable().describe(`
12912
+ * * Field Name: VectorIndexID
12913
+ * * Display Name: Vector Index
12914
+ * * SQL Data Type: uniqueidentifier
12915
+ * * Related Entity/Foreign Key: MJ: Vector Indexes (vwVectorIndexes.ID)
12916
+ * * Description: Optional foreign key to the specific Vector Index where this entity document's embeddings should be stored. When specified, the vectorization pipeline will upsert vectors directly to this index rather than auto-creating or looking up an index based on VectorDatabaseID + AIModelID. This enables explicit control over which Pinecone/Weaviate/etc. index is used per entity document, supporting multi-index architectures and shared indexes across entity types.`),
12917
+ Configuration: z.string().nullable().describe(`
12918
+ * * Field Name: Configuration
12919
+ * * Display Name: Configuration
12920
+ * * SQL Data Type: nvarchar(MAX)
12921
+ * * Description: JSON configuration settings for this entity document. Controls vector metadata field inclusion (which fields get stored in the vector index for search result display), large field truncation limits, and future settings like sync scheduling and threshold overrides. NULL means use system defaults.`),
12911
12922
  Type: z.string().describe(`
12912
12923
  * * Field Name: Type
12913
- * * Display Name: Type
12924
+ * * Display Name: Type Name
12914
12925
  * * SQL Data Type: nvarchar(100)`),
12915
12926
  Entity: z.string().describe(`
12916
12927
  * * Field Name: Entity
12917
- * * Display Name: Entity
12928
+ * * Display Name: Entity Name
12918
12929
  * * SQL Data Type: nvarchar(255)`),
12919
12930
  VectorDatabase: z.string().describe(`
12920
12931
  * * Field Name: VectorDatabase
12921
- * * Display Name: Vector Database
12932
+ * * Display Name: Vector Database Name
12922
12933
  * * SQL Data Type: nvarchar(100)`),
12923
12934
  Template: z.string().describe(`
12924
12935
  * * Field Name: Template
12925
- * * Display Name: Template
12936
+ * * Display Name: Template Name
12926
12937
  * * SQL Data Type: nvarchar(255)`),
12927
12938
  AIModel: z.string().describe(`
12928
12939
  * * Field Name: AIModel
12929
- * * Display Name: AIModel
12940
+ * * Display Name: AI Model Name
12930
12941
  * * SQL Data Type: nvarchar(50)`),
12942
+ VectorIndex: z.string().nullable().describe(`
12943
+ * * Field Name: VectorIndex
12944
+ * * Display Name: Vector Index Name
12945
+ * * SQL Data Type: nvarchar(255)`),
12931
12946
  });
12932
12947
  /**
12933
12948
  * zod schema definition for the entity MJ: Entity Field Values
@@ -22032,6 +22047,11 @@ export const MJVectorDatabaseSchema = z.object({
22032
22047
  * * Display Name: Updated At
22033
22048
  * * SQL Data Type: datetimeoffset
22034
22049
  * * Default Value: getutcdate()`),
22050
+ Configuration: z.string().nullable().describe(`
22051
+ * * Field Name: Configuration
22052
+ * * Display Name: Configuration
22053
+ * * SQL Data Type: nvarchar(MAX)
22054
+ * * Description: JSON configuration settings for this vector database provider. Stores provider-specific connection settings like custom host URLs, authentication configuration, timeouts, retry policies, and batch size limits. NULL means use defaults from environment variables or provider defaults.`),
22035
22055
  });
22036
22056
  /**
22037
22057
  * zod schema definition for the entity MJ: Vector Indexes
@@ -22052,12 +22072,12 @@ export const MJVectorIndexSchema = z.object({
22052
22072
  * * SQL Data Type: nvarchar(MAX)`),
22053
22073
  VectorDatabaseID: z.string().describe(`
22054
22074
  * * Field Name: VectorDatabaseID
22055
- * * Display Name: Vector Database ID
22075
+ * * Display Name: Vector Database
22056
22076
  * * SQL Data Type: uniqueidentifier
22057
22077
  * * Related Entity/Foreign Key: MJ: Vector Databases (vwVectorDatabases.ID)`),
22058
22078
  EmbeddingModelID: z.string().describe(`
22059
22079
  * * Field Name: EmbeddingModelID
22060
- * * Display Name: Embedding Model ID
22080
+ * * Display Name: Embedding Model
22061
22081
  * * SQL Data Type: uniqueidentifier
22062
22082
  * * Related Entity/Foreign Key: MJ: AI Models (vwAIModels.ID)`),
22063
22083
  __mj_CreatedAt: z.date().describe(`
@@ -22070,13 +22090,33 @@ export const MJVectorIndexSchema = z.object({
22070
22090
  * * Display Name: Updated At
22071
22091
  * * SQL Data Type: datetimeoffset
22072
22092
  * * Default Value: getutcdate()`),
22093
+ ExternalID: z.string().nullable().describe(`
22094
+ * * Field Name: ExternalID
22095
+ * * Display Name: External ID
22096
+ * * SQL Data Type: nvarchar(500)
22097
+ * * Description: The provider's native identifier for this index. For Pinecone this is the index name; for other providers it may be a separate UUID or identifier. Used for syncing operations between MJ metadata and the remote vector database.`),
22098
+ Dimensions: z.number().nullable().describe(`
22099
+ * * Field Name: Dimensions
22100
+ * * Display Name: Dimensions
22101
+ * * SQL Data Type: int
22102
+ * * Description: The number of dimensions for vectors stored in this index. Determined by the embedding model (e.g., 1536 for text-embedding-3-small, 768 for all-mpnet-base-v2). Set automatically when the index is created via the vector database provider.`),
22103
+ Metric: z.string().nullable().describe(`
22104
+ * * Field Name: Metric
22105
+ * * Display Name: Distance Metric
22106
+ * * SQL Data Type: nvarchar(50)
22107
+ * * Description: The distance metric used for similarity calculations in this index. Common values: cosine (default, measures angular similarity), euclidean (L2 distance), dotproduct (inner product). Must match what the vector database provider was configured with.`),
22108
+ ProviderConfig: z.string().nullable().describe(`
22109
+ * * Field Name: ProviderConfig
22110
+ * * Display Name: Provider Configuration
22111
+ * * SQL Data Type: nvarchar(MAX)
22112
+ * * Description: JSON object containing provider-specific configuration for this index. For Pinecone serverless: {"cloud":"aws","region":"us-east-1"}. For pod-based: {"environment":"us-east1-gcp","podType":"p1.x1","replicas":1}. Stored as a flexible JSON bag to support any provider without schema changes.`),
22073
22113
  VectorDatabase: z.string().describe(`
22074
22114
  * * Field Name: VectorDatabase
22075
- * * Display Name: Vector Database
22115
+ * * Display Name: Vector Database Name
22076
22116
  * * SQL Data Type: nvarchar(100)`),
22077
22117
  EmbeddingModel: z.string().describe(`
22078
22118
  * * Field Name: EmbeddingModel
22079
- * * Display Name: Embedding Model
22119
+ * * Display Name: Embedding Model Name
22080
22120
  * * SQL Data Type: nvarchar(50)`),
22081
22121
  });
22082
22122
  /**
@@ -55362,7 +55402,7 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55362
55402
  }
55363
55403
  /**
55364
55404
  * * Field Name: TypeID
55365
- * * Display Name: Type ID
55405
+ * * Display Name: Type
55366
55406
  * * SQL Data Type: uniqueidentifier
55367
55407
  * * Related Entity/Foreign Key: MJ: Entity Document Types (vwEntityDocumentTypes.ID)
55368
55408
  */
@@ -55374,7 +55414,7 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55374
55414
  }
55375
55415
  /**
55376
55416
  * * Field Name: EntityID
55377
- * * Display Name: Entity ID
55417
+ * * Display Name: Entity
55378
55418
  * * SQL Data Type: uniqueidentifier
55379
55419
  * * Related Entity/Foreign Key: MJ: Entities (vwEntities.ID)
55380
55420
  */
@@ -55386,7 +55426,7 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55386
55426
  }
55387
55427
  /**
55388
55428
  * * Field Name: VectorDatabaseID
55389
- * * Display Name: Vector Database ID
55429
+ * * Display Name: Vector Database
55390
55430
  * * SQL Data Type: uniqueidentifier
55391
55431
  * * Related Entity/Foreign Key: MJ: Vector Databases (vwVectorDatabases.ID)
55392
55432
  */
@@ -55414,7 +55454,7 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55414
55454
  }
55415
55455
  /**
55416
55456
  * * Field Name: TemplateID
55417
- * * Display Name: Template ID
55457
+ * * Display Name: Template
55418
55458
  * * SQL Data Type: uniqueidentifier
55419
55459
  * * Related Entity/Foreign Key: MJ: Templates (vwTemplates.ID)
55420
55460
  */
@@ -55426,7 +55466,7 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55426
55466
  }
55427
55467
  /**
55428
55468
  * * Field Name: AIModelID
55429
- * * Display Name: AIModel ID
55469
+ * * Display Name: AI Model
55430
55470
  * * SQL Data Type: uniqueidentifier
55431
55471
  * * Related Entity/Foreign Key: MJ: AI Models (vwAIModels.ID)
55432
55472
  */
@@ -55464,7 +55504,7 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55464
55504
  }
55465
55505
  /**
55466
55506
  * * Field Name: __mj_CreatedAt
55467
- * * Display Name: __mj _Created At
55507
+ * * Display Name: Created At
55468
55508
  * * SQL Data Type: datetimeoffset
55469
55509
  * * Default Value: getutcdate()
55470
55510
  */
@@ -55473,7 +55513,7 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55473
55513
  }
55474
55514
  /**
55475
55515
  * * Field Name: __mj_UpdatedAt
55476
- * * Display Name: __mj _Updated At
55516
+ * * Display Name: Updated At
55477
55517
  * * SQL Data Type: datetimeoffset
55478
55518
  * * Default Value: getutcdate()
55479
55519
  */
@@ -55481,8 +55521,33 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55481
55521
  return this.Get('__mj_UpdatedAt');
55482
55522
  }
55483
55523
  /**
55524
+ * * Field Name: VectorIndexID
55525
+ * * Display Name: Vector Index
55526
+ * * SQL Data Type: uniqueidentifier
55527
+ * * Related Entity/Foreign Key: MJ: Vector Indexes (vwVectorIndexes.ID)
55528
+ * * Description: Optional foreign key to the specific Vector Index where this entity document's embeddings should be stored. When specified, the vectorization pipeline will upsert vectors directly to this index rather than auto-creating or looking up an index based on VectorDatabaseID + AIModelID. This enables explicit control over which Pinecone/Weaviate/etc. index is used per entity document, supporting multi-index architectures and shared indexes across entity types.
55529
+ */
55530
+ get VectorIndexID() {
55531
+ return this.Get('VectorIndexID');
55532
+ }
55533
+ set VectorIndexID(value) {
55534
+ this.Set('VectorIndexID', value);
55535
+ }
55536
+ /**
55537
+ * * Field Name: Configuration
55538
+ * * Display Name: Configuration
55539
+ * * SQL Data Type: nvarchar(MAX)
55540
+ * * Description: JSON configuration settings for this entity document. Controls vector metadata field inclusion (which fields get stored in the vector index for search result display), large field truncation limits, and future settings like sync scheduling and threshold overrides. NULL means use system defaults.
55541
+ */
55542
+ get Configuration() {
55543
+ return this.Get('Configuration');
55544
+ }
55545
+ set Configuration(value) {
55546
+ this.Set('Configuration', value);
55547
+ }
55548
+ /**
55484
55549
  * * Field Name: Type
55485
- * * Display Name: Type
55550
+ * * Display Name: Type Name
55486
55551
  * * SQL Data Type: nvarchar(100)
55487
55552
  */
55488
55553
  get Type() {
@@ -55490,7 +55555,7 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55490
55555
  }
55491
55556
  /**
55492
55557
  * * Field Name: Entity
55493
- * * Display Name: Entity
55558
+ * * Display Name: Entity Name
55494
55559
  * * SQL Data Type: nvarchar(255)
55495
55560
  */
55496
55561
  get Entity() {
@@ -55498,7 +55563,7 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55498
55563
  }
55499
55564
  /**
55500
55565
  * * Field Name: VectorDatabase
55501
- * * Display Name: Vector Database
55566
+ * * Display Name: Vector Database Name
55502
55567
  * * SQL Data Type: nvarchar(100)
55503
55568
  */
55504
55569
  get VectorDatabase() {
@@ -55506,7 +55571,7 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55506
55571
  }
55507
55572
  /**
55508
55573
  * * Field Name: Template
55509
- * * Display Name: Template
55574
+ * * Display Name: Template Name
55510
55575
  * * SQL Data Type: nvarchar(255)
55511
55576
  */
55512
55577
  get Template() {
@@ -55514,12 +55579,20 @@ let MJEntityDocumentEntity = class MJEntityDocumentEntity extends BaseEntity {
55514
55579
  }
55515
55580
  /**
55516
55581
  * * Field Name: AIModel
55517
- * * Display Name: AIModel
55582
+ * * Display Name: AI Model Name
55518
55583
  * * SQL Data Type: nvarchar(50)
55519
55584
  */
55520
55585
  get AIModel() {
55521
55586
  return this.Get('AIModel');
55522
55587
  }
55588
+ /**
55589
+ * * Field Name: VectorIndex
55590
+ * * Display Name: Vector Index Name
55591
+ * * SQL Data Type: nvarchar(255)
55592
+ */
55593
+ get VectorIndex() {
55594
+ return this.Get('VectorIndex');
55595
+ }
55523
55596
  };
55524
55597
  MJEntityDocumentEntity = __decorate([
55525
55598
  RegisterClass(BaseEntity, 'MJ: Entity Documents')
@@ -78483,6 +78556,18 @@ let MJVectorDatabaseEntity = class MJVectorDatabaseEntity extends BaseEntity {
78483
78556
  get __mj_UpdatedAt() {
78484
78557
  return this.Get('__mj_UpdatedAt');
78485
78558
  }
78559
+ /**
78560
+ * * Field Name: Configuration
78561
+ * * Display Name: Configuration
78562
+ * * SQL Data Type: nvarchar(MAX)
78563
+ * * Description: JSON configuration settings for this vector database provider. Stores provider-specific connection settings like custom host URLs, authentication configuration, timeouts, retry policies, and batch size limits. NULL means use defaults from environment variables or provider defaults.
78564
+ */
78565
+ get Configuration() {
78566
+ return this.Get('Configuration');
78567
+ }
78568
+ set Configuration(value) {
78569
+ this.Set('Configuration', value);
78570
+ }
78486
78571
  };
78487
78572
  MJVectorDatabaseEntity = __decorate([
78488
78573
  RegisterClass(BaseEntity, 'MJ: Vector Databases')
@@ -78552,7 +78637,7 @@ let MJVectorIndexEntity = class MJVectorIndexEntity extends BaseEntity {
78552
78637
  }
78553
78638
  /**
78554
78639
  * * Field Name: VectorDatabaseID
78555
- * * Display Name: Vector Database ID
78640
+ * * Display Name: Vector Database
78556
78641
  * * SQL Data Type: uniqueidentifier
78557
78642
  * * Related Entity/Foreign Key: MJ: Vector Databases (vwVectorDatabases.ID)
78558
78643
  */
@@ -78564,7 +78649,7 @@ let MJVectorIndexEntity = class MJVectorIndexEntity extends BaseEntity {
78564
78649
  }
78565
78650
  /**
78566
78651
  * * Field Name: EmbeddingModelID
78567
- * * Display Name: Embedding Model ID
78652
+ * * Display Name: Embedding Model
78568
78653
  * * SQL Data Type: uniqueidentifier
78569
78654
  * * Related Entity/Foreign Key: MJ: AI Models (vwAIModels.ID)
78570
78655
  */
@@ -78593,8 +78678,56 @@ let MJVectorIndexEntity = class MJVectorIndexEntity extends BaseEntity {
78593
78678
  return this.Get('__mj_UpdatedAt');
78594
78679
  }
78595
78680
  /**
78681
+ * * Field Name: ExternalID
78682
+ * * Display Name: External ID
78683
+ * * SQL Data Type: nvarchar(500)
78684
+ * * Description: The provider's native identifier for this index. For Pinecone this is the index name; for other providers it may be a separate UUID or identifier. Used for syncing operations between MJ metadata and the remote vector database.
78685
+ */
78686
+ get ExternalID() {
78687
+ return this.Get('ExternalID');
78688
+ }
78689
+ set ExternalID(value) {
78690
+ this.Set('ExternalID', value);
78691
+ }
78692
+ /**
78693
+ * * Field Name: Dimensions
78694
+ * * Display Name: Dimensions
78695
+ * * SQL Data Type: int
78696
+ * * Description: The number of dimensions for vectors stored in this index. Determined by the embedding model (e.g., 1536 for text-embedding-3-small, 768 for all-mpnet-base-v2). Set automatically when the index is created via the vector database provider.
78697
+ */
78698
+ get Dimensions() {
78699
+ return this.Get('Dimensions');
78700
+ }
78701
+ set Dimensions(value) {
78702
+ this.Set('Dimensions', value);
78703
+ }
78704
+ /**
78705
+ * * Field Name: Metric
78706
+ * * Display Name: Distance Metric
78707
+ * * SQL Data Type: nvarchar(50)
78708
+ * * Description: The distance metric used for similarity calculations in this index. Common values: cosine (default, measures angular similarity), euclidean (L2 distance), dotproduct (inner product). Must match what the vector database provider was configured with.
78709
+ */
78710
+ get Metric() {
78711
+ return this.Get('Metric');
78712
+ }
78713
+ set Metric(value) {
78714
+ this.Set('Metric', value);
78715
+ }
78716
+ /**
78717
+ * * Field Name: ProviderConfig
78718
+ * * Display Name: Provider Configuration
78719
+ * * SQL Data Type: nvarchar(MAX)
78720
+ * * Description: JSON object containing provider-specific configuration for this index. For Pinecone serverless: {"cloud":"aws","region":"us-east-1"}. For pod-based: {"environment":"us-east1-gcp","podType":"p1.x1","replicas":1}. Stored as a flexible JSON bag to support any provider without schema changes.
78721
+ */
78722
+ get ProviderConfig() {
78723
+ return this.Get('ProviderConfig');
78724
+ }
78725
+ set ProviderConfig(value) {
78726
+ this.Set('ProviderConfig', value);
78727
+ }
78728
+ /**
78596
78729
  * * Field Name: VectorDatabase
78597
- * * Display Name: Vector Database
78730
+ * * Display Name: Vector Database Name
78598
78731
  * * SQL Data Type: nvarchar(100)
78599
78732
  */
78600
78733
  get VectorDatabase() {
@@ -78602,7 +78735,7 @@ let MJVectorIndexEntity = class MJVectorIndexEntity extends BaseEntity {
78602
78735
  }
78603
78736
  /**
78604
78737
  * * Field Name: EmbeddingModel
78605
- * * Display Name: Embedding Model
78738
+ * * Display Name: Embedding Model Name
78606
78739
  * * SQL Data Type: nvarchar(50)
78607
78740
  */
78608
78741
  get EmbeddingModel() {