@memberjunction/core-entities 2.2.1 → 2.3.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.
@@ -479,6 +479,7 @@ export declare const AIModelSchema: z.ZodObject<{
479
479
  __mj_UpdatedAt: z.ZodDate;
480
480
  SpeedRank: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
481
481
  CostRank: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
482
+ ModelSelectionInsights: z.ZodOptional<z.ZodNullable<z.ZodString>>;
482
483
  AIModelType: z.ZodString;
483
484
  }, "strip", z.ZodTypeAny, {
484
485
  ID?: string;
@@ -495,6 +496,7 @@ export declare const AIModelSchema: z.ZodObject<{
495
496
  APIName?: string;
496
497
  SpeedRank?: number;
497
498
  CostRank?: number;
499
+ ModelSelectionInsights?: string;
498
500
  AIModelType?: string;
499
501
  }, {
500
502
  ID?: string;
@@ -511,9 +513,156 @@ export declare const AIModelSchema: z.ZodObject<{
511
513
  APIName?: string;
512
514
  SpeedRank?: number;
513
515
  CostRank?: number;
516
+ ModelSelectionInsights?: string;
514
517
  AIModelType?: string;
515
518
  }>;
516
519
  export type AIModelEntityType = z.infer<typeof AIModelSchema>;
520
+ /**
521
+ * zod schema definition for the entity AI Prompt Categories
522
+ */
523
+ export declare const AIPromptCategorySchema: z.ZodObject<{
524
+ ID: z.ZodString;
525
+ Name: z.ZodString;
526
+ ParentID: z.ZodOptional<z.ZodNullable<z.ZodString>>;
527
+ Description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
528
+ __mj_CreatedAt: z.ZodDate;
529
+ __mj_UpdatedAt: z.ZodDate;
530
+ Parent: z.ZodOptional<z.ZodNullable<z.ZodString>>;
531
+ }, "strip", z.ZodTypeAny, {
532
+ ID?: string;
533
+ __mj_CreatedAt?: Date;
534
+ __mj_UpdatedAt?: Date;
535
+ Name?: string;
536
+ Description?: string;
537
+ ParentID?: string;
538
+ Parent?: string;
539
+ }, {
540
+ ID?: string;
541
+ __mj_CreatedAt?: Date;
542
+ __mj_UpdatedAt?: Date;
543
+ Name?: string;
544
+ Description?: string;
545
+ ParentID?: string;
546
+ Parent?: string;
547
+ }>;
548
+ export type AIPromptCategoryEntityType = z.infer<typeof AIPromptCategorySchema>;
549
+ /**
550
+ * zod schema definition for the entity AI Prompt Types
551
+ */
552
+ export declare const AIPromptTypeSchema: z.ZodObject<{
553
+ ID: z.ZodString;
554
+ Name: z.ZodString;
555
+ Description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
556
+ __mj_CreatedAt: z.ZodDate;
557
+ __mj_UpdatedAt: z.ZodDate;
558
+ }, "strip", z.ZodTypeAny, {
559
+ ID?: string;
560
+ __mj_CreatedAt?: Date;
561
+ __mj_UpdatedAt?: Date;
562
+ Name?: string;
563
+ Description?: string;
564
+ }, {
565
+ ID?: string;
566
+ __mj_CreatedAt?: Date;
567
+ __mj_UpdatedAt?: Date;
568
+ Name?: string;
569
+ Description?: string;
570
+ }>;
571
+ export type AIPromptTypeEntityType = z.infer<typeof AIPromptTypeSchema>;
572
+ /**
573
+ * zod schema definition for the entity AI Prompts
574
+ */
575
+ export declare const AIPromptSchema: z.ZodObject<{
576
+ ID: z.ZodString;
577
+ Name: z.ZodString;
578
+ Description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
579
+ TemplateID: z.ZodString;
580
+ CategoryID: z.ZodOptional<z.ZodNullable<z.ZodString>>;
581
+ TypeID: z.ZodString;
582
+ Status: z.ZodUnion<[z.ZodLiteral<"Pending">, z.ZodLiteral<"Active">, z.ZodLiteral<"Disabled">]>;
583
+ CacheResults: z.ZodBoolean;
584
+ CacheExpiration: z.ZodNumber;
585
+ __mj_CreatedAt: z.ZodDate;
586
+ __mj_UpdatedAt: z.ZodDate;
587
+ Template: z.ZodString;
588
+ Category: z.ZodOptional<z.ZodNullable<z.ZodString>>;
589
+ Type: z.ZodString;
590
+ }, "strip", z.ZodTypeAny, {
591
+ Category?: string;
592
+ ID?: string;
593
+ __mj_CreatedAt?: Date;
594
+ __mj_UpdatedAt?: Date;
595
+ Name?: string;
596
+ Description?: string;
597
+ Status?: "Pending" | "Active" | "Disabled";
598
+ Type?: string;
599
+ CategoryID?: string;
600
+ TemplateID?: string;
601
+ TypeID?: string;
602
+ CacheResults?: boolean;
603
+ CacheExpiration?: number;
604
+ Template?: string;
605
+ }, {
606
+ Category?: string;
607
+ ID?: string;
608
+ __mj_CreatedAt?: Date;
609
+ __mj_UpdatedAt?: Date;
610
+ Name?: string;
611
+ Description?: string;
612
+ Status?: "Pending" | "Active" | "Disabled";
613
+ Type?: string;
614
+ CategoryID?: string;
615
+ TemplateID?: string;
616
+ TypeID?: string;
617
+ CacheResults?: boolean;
618
+ CacheExpiration?: number;
619
+ Template?: string;
620
+ }>;
621
+ export type AIPromptEntityType = z.infer<typeof AIPromptSchema>;
622
+ /**
623
+ * zod schema definition for the entity AI Result Cache
624
+ */
625
+ export declare const AIResultCacheSchema: z.ZodObject<{
626
+ ID: z.ZodString;
627
+ AIPromptID: z.ZodString;
628
+ AIModelID: z.ZodString;
629
+ RunAt: z.ZodDate;
630
+ PromptText: z.ZodString;
631
+ ResultText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
632
+ Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Expired">]>;
633
+ ExpiredOn: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
634
+ __mj_CreatedAt: z.ZodDate;
635
+ __mj_UpdatedAt: z.ZodDate;
636
+ AIPrompt: z.ZodString;
637
+ AIModel: z.ZodString;
638
+ }, "strip", z.ZodTypeAny, {
639
+ ID?: string;
640
+ __mj_CreatedAt?: Date;
641
+ __mj_UpdatedAt?: Date;
642
+ Status?: "Active" | "Expired";
643
+ AIModelID?: string;
644
+ AIModel?: string;
645
+ AIPromptID?: string;
646
+ RunAt?: Date;
647
+ PromptText?: string;
648
+ ResultText?: string;
649
+ ExpiredOn?: Date;
650
+ AIPrompt?: string;
651
+ }, {
652
+ ID?: string;
653
+ __mj_CreatedAt?: Date;
654
+ __mj_UpdatedAt?: Date;
655
+ Status?: "Active" | "Expired";
656
+ AIModelID?: string;
657
+ AIModel?: string;
658
+ AIPromptID?: string;
659
+ RunAt?: Date;
660
+ PromptText?: string;
661
+ ResultText?: string;
662
+ ExpiredOn?: Date;
663
+ AIPrompt?: string;
664
+ }>;
665
+ export type AIResultCacheEntityType = z.infer<typeof AIResultCacheSchema>;
517
666
  /**
518
667
  * zod schema definition for the entity Application Entities
519
668
  */
@@ -2383,15 +2532,15 @@ export declare const EntityDocumentSchema: z.ZodObject<{
2383
2532
  Type?: string;
2384
2533
  AIModelID?: string;
2385
2534
  AIModel?: string;
2535
+ TemplateID?: string;
2536
+ TypeID?: string;
2537
+ Template?: string;
2386
2538
  EntityID?: string;
2387
2539
  Entity?: string;
2388
- TypeID?: string;
2389
2540
  VectorDatabaseID?: string;
2390
- TemplateID?: string;
2391
2541
  PotentialMatchThreshold?: number;
2392
2542
  AbsoluteMatchThreshold?: number;
2393
2543
  VectorDatabase?: string;
2394
- Template?: string;
2395
2544
  }, {
2396
2545
  ID?: string;
2397
2546
  __mj_CreatedAt?: Date;
@@ -2401,15 +2550,15 @@ export declare const EntityDocumentSchema: z.ZodObject<{
2401
2550
  Type?: string;
2402
2551
  AIModelID?: string;
2403
2552
  AIModel?: string;
2553
+ TemplateID?: string;
2554
+ TypeID?: string;
2555
+ Template?: string;
2404
2556
  EntityID?: string;
2405
2557
  Entity?: string;
2406
- TypeID?: string;
2407
2558
  VectorDatabaseID?: string;
2408
- TemplateID?: string;
2409
2559
  PotentialMatchThreshold?: number;
2410
2560
  AbsoluteMatchThreshold?: number;
2411
2561
  VectorDatabase?: string;
2412
- Template?: string;
2413
2562
  }>;
2414
2563
  export type EntityDocumentEntityType = z.infer<typeof EntityDocumentSchema>;
2415
2564
  /**
@@ -4668,10 +4817,10 @@ export declare const TemplateContentSchema: z.ZodObject<{
4668
4817
  __mj_UpdatedAt?: Date;
4669
4818
  Type?: string;
4670
4819
  IsActive?: boolean;
4671
- Priority?: number;
4672
- TypeID?: string;
4673
4820
  TemplateID?: string;
4821
+ TypeID?: string;
4674
4822
  Template?: string;
4823
+ Priority?: number;
4675
4824
  TemplateText?: string;
4676
4825
  }, {
4677
4826
  ID?: string;
@@ -4679,10 +4828,10 @@ export declare const TemplateContentSchema: z.ZodObject<{
4679
4828
  __mj_UpdatedAt?: Date;
4680
4829
  Type?: string;
4681
4830
  IsActive?: boolean;
4682
- Priority?: number;
4683
- TypeID?: string;
4684
4831
  TemplateID?: string;
4832
+ TypeID?: string;
4685
4833
  Template?: string;
4834
+ Priority?: number;
4686
4835
  TemplateText?: string;
4687
4836
  }>;
4688
4837
  export type TemplateContentEntityType = z.infer<typeof TemplateContentSchema>;
@@ -4715,11 +4864,11 @@ export declare const TemplateParamSchema: z.ZodObject<{
4715
4864
  DefaultValue?: string;
4716
4865
  Type?: "Scalar" | "Entity" | "Array" | "Object" | "Record";
4717
4866
  IsRequired?: boolean;
4867
+ TemplateID?: string;
4868
+ Template?: string;
4718
4869
  EntityID?: string;
4719
4870
  Entity?: string;
4720
4871
  RecordID?: string;
4721
- TemplateID?: string;
4722
- Template?: string;
4723
4872
  LinkedParameterName?: string;
4724
4873
  LinkedParameterField?: string;
4725
4874
  ExtraFilter?: string;
@@ -4732,11 +4881,11 @@ export declare const TemplateParamSchema: z.ZodObject<{
4732
4881
  DefaultValue?: string;
4733
4882
  Type?: "Scalar" | "Entity" | "Array" | "Object" | "Record";
4734
4883
  IsRequired?: boolean;
4884
+ TemplateID?: string;
4885
+ Template?: string;
4735
4886
  EntityID?: string;
4736
4887
  Entity?: string;
4737
4888
  RecordID?: string;
4738
- TemplateID?: string;
4739
- Template?: string;
4740
4889
  LinkedParameterName?: string;
4741
4890
  LinkedParameterField?: string;
4742
4891
  ExtraFilter?: string;
@@ -5109,19 +5258,19 @@ export declare const UserViewRunSchema: z.ZodObject<{
5109
5258
  ID?: string;
5110
5259
  __mj_CreatedAt?: Date;
5111
5260
  __mj_UpdatedAt?: Date;
5261
+ RunAt?: Date;
5112
5262
  RunByUserID?: string;
5113
5263
  RunByUser?: string;
5114
5264
  UserViewID?: string;
5115
- RunAt?: Date;
5116
5265
  UserView?: string;
5117
5266
  }, {
5118
5267
  ID?: string;
5119
5268
  __mj_CreatedAt?: Date;
5120
5269
  __mj_UpdatedAt?: Date;
5270
+ RunAt?: Date;
5121
5271
  RunByUserID?: string;
5122
5272
  RunByUser?: string;
5123
5273
  UserViewID?: string;
5124
- RunAt?: Date;
5125
5274
  UserView?: string;
5126
5275
  }>;
5127
5276
  export type UserViewRunEntityType = z.infer<typeof UserViewRunSchema>;
@@ -6935,12 +7084,411 @@ export declare class AIModelEntity extends BaseEntity<AIModelEntityType> {
6935
7084
  get CostRank(): number | null;
6936
7085
  set CostRank(value: number | null);
6937
7086
  /**
7087
+ * * Field Name: ModelSelectionInsights
7088
+ * * Display Name: Model Selection Insights
7089
+ * * SQL Data Type: nvarchar(MAX)
7090
+ * * Default Value: null
7091
+ * * Description: This column stores unstructured text notes that provide insights into what the model is particularly good at and areas where it may not perform as well. These notes can be used by a human or an AI to determine if the model is a good fit for various purposes.
7092
+ */
7093
+ get ModelSelectionInsights(): string | null;
7094
+ set ModelSelectionInsights(value: string | null);
7095
+ /**
6938
7096
  * * Field Name: AIModelType
6939
7097
  * * Display Name: AIModel Type
6940
7098
  * * SQL Data Type: nvarchar(50)
6941
7099
  */
6942
7100
  get AIModelType(): string;
6943
7101
  }
7102
+ /**
7103
+ * AI Prompt Categories - strongly typed entity sub-class
7104
+ * * Schema: __mj
7105
+ * * Base Table: AIPromptCategory
7106
+ * * Base View: vwAIPromptCategories
7107
+ * * @description Categories for organizing AI prompts in a hierarchical structure.
7108
+ * * Primary Key: ID
7109
+ * @extends {BaseEntity}
7110
+ * @class
7111
+ * @public
7112
+ */
7113
+ export declare class AIPromptCategoryEntity extends BaseEntity<AIPromptCategoryEntityType> {
7114
+ /**
7115
+ * Loads the AI Prompt Categories record from the database
7116
+ * @param ID: string - primary key value to load the AI Prompt Categories record.
7117
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
7118
+ * @returns {Promise<boolean>} - true if successful, false otherwise
7119
+ * @public
7120
+ * @async
7121
+ * @memberof AIPromptCategoryEntity
7122
+ * @method
7123
+ * @override
7124
+ */
7125
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
7126
+ /**
7127
+ * * Field Name: ID
7128
+ * * Display Name: ID
7129
+ * * SQL Data Type: uniqueidentifier
7130
+ * * Default Value: newsequentialid()
7131
+ */
7132
+ get ID(): string;
7133
+ /**
7134
+ * * Field Name: Name
7135
+ * * Display Name: Name
7136
+ * * SQL Data Type: nvarchar(255)
7137
+ */
7138
+ get Name(): string;
7139
+ set Name(value: string);
7140
+ /**
7141
+ * * Field Name: ParentID
7142
+ * * Display Name: Parent ID
7143
+ * * SQL Data Type: uniqueidentifier
7144
+ * * Related Entity/Foreign Key: AI Prompt Categories (vwAIPromptCategories.ID)
7145
+ * * Description: Parent category ID for hierarchical organization.
7146
+ */
7147
+ get ParentID(): string | null;
7148
+ set ParentID(value: string | null);
7149
+ /**
7150
+ * * Field Name: Description
7151
+ * * Display Name: Description
7152
+ * * SQL Data Type: nvarchar(MAX)
7153
+ */
7154
+ get Description(): string | null;
7155
+ set Description(value: string | null);
7156
+ /**
7157
+ * * Field Name: __mj_CreatedAt
7158
+ * * Display Name: Created At
7159
+ * * SQL Data Type: datetimeoffset
7160
+ * * Default Value: getutcdate()
7161
+ */
7162
+ get __mj_CreatedAt(): Date;
7163
+ /**
7164
+ * * Field Name: __mj_UpdatedAt
7165
+ * * Display Name: Updated At
7166
+ * * SQL Data Type: datetimeoffset
7167
+ * * Default Value: getutcdate()
7168
+ */
7169
+ get __mj_UpdatedAt(): Date;
7170
+ /**
7171
+ * * Field Name: Parent
7172
+ * * Display Name: Parent
7173
+ * * SQL Data Type: nvarchar(255)
7174
+ */
7175
+ get Parent(): string | null;
7176
+ }
7177
+ /**
7178
+ * AI Prompt Types - strongly typed entity sub-class
7179
+ * * Schema: __mj
7180
+ * * Base Table: AIPromptType
7181
+ * * Base View: vwAIPromptTypes
7182
+ * * @description Types of AI prompts such as Chat, Text-to-Image, Text-to-Video, etc.
7183
+ * * Primary Key: ID
7184
+ * @extends {BaseEntity}
7185
+ * @class
7186
+ * @public
7187
+ */
7188
+ export declare class AIPromptTypeEntity extends BaseEntity<AIPromptTypeEntityType> {
7189
+ /**
7190
+ * Loads the AI Prompt Types record from the database
7191
+ * @param ID: string - primary key value to load the AI Prompt Types record.
7192
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
7193
+ * @returns {Promise<boolean>} - true if successful, false otherwise
7194
+ * @public
7195
+ * @async
7196
+ * @memberof AIPromptTypeEntity
7197
+ * @method
7198
+ * @override
7199
+ */
7200
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
7201
+ /**
7202
+ * * Field Name: ID
7203
+ * * Display Name: ID
7204
+ * * SQL Data Type: uniqueidentifier
7205
+ * * Default Value: newsequentialid()
7206
+ */
7207
+ get ID(): string;
7208
+ /**
7209
+ * * Field Name: Name
7210
+ * * Display Name: Name
7211
+ * * SQL Data Type: nvarchar(255)
7212
+ */
7213
+ get Name(): string;
7214
+ set Name(value: string);
7215
+ /**
7216
+ * * Field Name: Description
7217
+ * * Display Name: Description
7218
+ * * SQL Data Type: nvarchar(MAX)
7219
+ */
7220
+ get Description(): string | null;
7221
+ set Description(value: string | null);
7222
+ /**
7223
+ * * Field Name: __mj_CreatedAt
7224
+ * * Display Name: Created At
7225
+ * * SQL Data Type: datetimeoffset
7226
+ * * Default Value: getutcdate()
7227
+ */
7228
+ get __mj_CreatedAt(): Date;
7229
+ /**
7230
+ * * Field Name: __mj_UpdatedAt
7231
+ * * Display Name: Updated At
7232
+ * * SQL Data Type: datetimeoffset
7233
+ * * Default Value: getutcdate()
7234
+ */
7235
+ get __mj_UpdatedAt(): Date;
7236
+ }
7237
+ /**
7238
+ * AI Prompts - strongly typed entity sub-class
7239
+ * * Schema: __mj
7240
+ * * Base Table: AIPrompt
7241
+ * * Base View: vwAIPrompts
7242
+ * * @description Stores AI prompts, including references to categories, types, and templates.
7243
+ * * Primary Key: ID
7244
+ * @extends {BaseEntity}
7245
+ * @class
7246
+ * @public
7247
+ */
7248
+ export declare class AIPromptEntity extends BaseEntity<AIPromptEntityType> {
7249
+ /**
7250
+ * Loads the AI Prompts record from the database
7251
+ * @param ID: string - primary key value to load the AI Prompts record.
7252
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
7253
+ * @returns {Promise<boolean>} - true if successful, false otherwise
7254
+ * @public
7255
+ * @async
7256
+ * @memberof AIPromptEntity
7257
+ * @method
7258
+ * @override
7259
+ */
7260
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
7261
+ /**
7262
+ * * Field Name: ID
7263
+ * * Display Name: ID
7264
+ * * SQL Data Type: uniqueidentifier
7265
+ * * Default Value: newsequentialid()
7266
+ */
7267
+ get ID(): string;
7268
+ /**
7269
+ * * Field Name: Name
7270
+ * * Display Name: Name
7271
+ * * SQL Data Type: nvarchar(255)
7272
+ */
7273
+ get Name(): string;
7274
+ set Name(value: string);
7275
+ /**
7276
+ * * Field Name: Description
7277
+ * * Display Name: Description
7278
+ * * SQL Data Type: nvarchar(MAX)
7279
+ */
7280
+ get Description(): string | null;
7281
+ set Description(value: string | null);
7282
+ /**
7283
+ * * Field Name: TemplateID
7284
+ * * Display Name: Template ID
7285
+ * * SQL Data Type: uniqueidentifier
7286
+ * * Related Entity/Foreign Key: Templates (vwTemplates.ID)
7287
+ * * Description: Reference to the template used for the prompt.
7288
+ */
7289
+ get TemplateID(): string;
7290
+ set TemplateID(value: string);
7291
+ /**
7292
+ * * Field Name: CategoryID
7293
+ * * Display Name: Category ID
7294
+ * * SQL Data Type: uniqueidentifier
7295
+ * * Related Entity/Foreign Key: AI Prompt Categories (vwAIPromptCategories.ID)
7296
+ * * Description: Reference to the category the prompt belongs to.
7297
+ */
7298
+ get CategoryID(): string | null;
7299
+ set CategoryID(value: string | null);
7300
+ /**
7301
+ * * Field Name: TypeID
7302
+ * * Display Name: Type ID
7303
+ * * SQL Data Type: uniqueidentifier
7304
+ * * Related Entity/Foreign Key: AI Prompt Types (vwAIPromptTypes.ID)
7305
+ * * Description: Reference to the type of the prompt.
7306
+ */
7307
+ get TypeID(): string;
7308
+ set TypeID(value: string);
7309
+ /**
7310
+ * * Field Name: Status
7311
+ * * Display Name: Status
7312
+ * * SQL Data Type: nvarchar(50)
7313
+ * * Value List Type: List
7314
+ * * Possible Values
7315
+ * * Pending
7316
+ * * Active
7317
+ * * Disabled
7318
+ */
7319
+ get Status(): 'Pending' | 'Active' | 'Disabled';
7320
+ set Status(value: 'Pending' | 'Active' | 'Disabled');
7321
+ /**
7322
+ * * Field Name: CacheResults
7323
+ * * Display Name: Cache Results
7324
+ * * SQL Data Type: bit
7325
+ * * Default Value: 0
7326
+ * * Description: Indicates whether the results of the prompt should be cached.
7327
+ */
7328
+ get CacheResults(): boolean;
7329
+ set CacheResults(value: boolean);
7330
+ /**
7331
+ * * Field Name: CacheExpiration
7332
+ * * Display Name: Cache Expiration
7333
+ * * SQL Data Type: decimal(10, 2)
7334
+ * * Default Value: 0
7335
+ * * Description: Number of hours the cache is valid for; can be fractional or 0 if the cache never expires.
7336
+ */
7337
+ get CacheExpiration(): number;
7338
+ set CacheExpiration(value: number);
7339
+ /**
7340
+ * * Field Name: __mj_CreatedAt
7341
+ * * Display Name: Created At
7342
+ * * SQL Data Type: datetimeoffset
7343
+ * * Default Value: getutcdate()
7344
+ */
7345
+ get __mj_CreatedAt(): Date;
7346
+ /**
7347
+ * * Field Name: __mj_UpdatedAt
7348
+ * * Display Name: Updated At
7349
+ * * SQL Data Type: datetimeoffset
7350
+ * * Default Value: getutcdate()
7351
+ */
7352
+ get __mj_UpdatedAt(): Date;
7353
+ /**
7354
+ * * Field Name: Template
7355
+ * * Display Name: Template
7356
+ * * SQL Data Type: nvarchar(255)
7357
+ */
7358
+ get Template(): string;
7359
+ /**
7360
+ * * Field Name: Category
7361
+ * * Display Name: Category
7362
+ * * SQL Data Type: nvarchar(255)
7363
+ */
7364
+ get Category(): string | null;
7365
+ /**
7366
+ * * Field Name: Type
7367
+ * * Display Name: Type
7368
+ * * SQL Data Type: nvarchar(255)
7369
+ */
7370
+ get Type(): string;
7371
+ }
7372
+ /**
7373
+ * AI Result Cache - strongly typed entity sub-class
7374
+ * * Schema: __mj
7375
+ * * Base Table: AIResultCache
7376
+ * * Base View: vwAIResultCaches
7377
+ * * @description Stores cached results of AI prompts, including multiple runs for history and tracking purposes.
7378
+ * * Primary Key: ID
7379
+ * @extends {BaseEntity}
7380
+ * @class
7381
+ * @public
7382
+ */
7383
+ export declare class AIResultCacheEntity extends BaseEntity<AIResultCacheEntityType> {
7384
+ /**
7385
+ * Loads the AI Result Cache record from the database
7386
+ * @param ID: string - primary key value to load the AI Result Cache record.
7387
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
7388
+ * @returns {Promise<boolean>} - true if successful, false otherwise
7389
+ * @public
7390
+ * @async
7391
+ * @memberof AIResultCacheEntity
7392
+ * @method
7393
+ * @override
7394
+ */
7395
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
7396
+ /**
7397
+ * * Field Name: ID
7398
+ * * Display Name: ID
7399
+ * * SQL Data Type: uniqueidentifier
7400
+ * * Default Value: newsequentialid()
7401
+ */
7402
+ get ID(): string;
7403
+ /**
7404
+ * * Field Name: AIPromptID
7405
+ * * Display Name: AIPrompt ID
7406
+ * * SQL Data Type: uniqueidentifier
7407
+ * * Related Entity/Foreign Key: AI Prompts (vwAIPrompts.ID)
7408
+ * * Description: Reference to the AI prompt this result corresponds to.
7409
+ */
7410
+ get AIPromptID(): string;
7411
+ set AIPromptID(value: string);
7412
+ /**
7413
+ * * Field Name: AIModelID
7414
+ * * Display Name: AIModel ID
7415
+ * * SQL Data Type: uniqueidentifier
7416
+ * * Related Entity/Foreign Key: AI Models (vwAIModels.ID)
7417
+ * * Description: Reference to the AI model that generated this result.
7418
+ */
7419
+ get AIModelID(): string;
7420
+ set AIModelID(value: string);
7421
+ /**
7422
+ * * Field Name: RunAt
7423
+ * * Display Name: Run At
7424
+ * * SQL Data Type: datetimeoffset
7425
+ * * Description: Timestamp of when this result was generated.
7426
+ */
7427
+ get RunAt(): Date;
7428
+ set RunAt(value: Date);
7429
+ /**
7430
+ * * Field Name: PromptText
7431
+ * * Display Name: Prompt Text
7432
+ * * SQL Data Type: nvarchar(MAX)
7433
+ * * Description: The prompt text used to generate this result.
7434
+ */
7435
+ get PromptText(): string;
7436
+ set PromptText(value: string);
7437
+ /**
7438
+ * * Field Name: ResultText
7439
+ * * Display Name: Result Text
7440
+ * * SQL Data Type: nvarchar(MAX)
7441
+ * * Description: The text of the result generated by the AI model.
7442
+ */
7443
+ get ResultText(): string | null;
7444
+ set ResultText(value: string | null);
7445
+ /**
7446
+ * * Field Name: Status
7447
+ * * Display Name: Status
7448
+ * * SQL Data Type: nvarchar(50)
7449
+ * * Value List Type: List
7450
+ * * Possible Values
7451
+ * * Active
7452
+ * * Expired
7453
+ * * Description: The status of this result, indicating whether it is currently active or expired.
7454
+ */
7455
+ get Status(): 'Active' | 'Expired';
7456
+ set Status(value: 'Active' | 'Expired');
7457
+ /**
7458
+ * * Field Name: ExpiredOn
7459
+ * * Display Name: Expired On
7460
+ * * SQL Data Type: datetimeoffset
7461
+ * * Description: Timestamp of when this result was marked as expired.
7462
+ */
7463
+ get ExpiredOn(): Date | null;
7464
+ set ExpiredOn(value: Date | null);
7465
+ /**
7466
+ * * Field Name: __mj_CreatedAt
7467
+ * * Display Name: Created At
7468
+ * * SQL Data Type: datetimeoffset
7469
+ * * Default Value: getutcdate()
7470
+ */
7471
+ get __mj_CreatedAt(): Date;
7472
+ /**
7473
+ * * Field Name: __mj_UpdatedAt
7474
+ * * Display Name: Updated At
7475
+ * * SQL Data Type: datetimeoffset
7476
+ * * Default Value: getutcdate()
7477
+ */
7478
+ get __mj_UpdatedAt(): Date;
7479
+ /**
7480
+ * * Field Name: AIPrompt
7481
+ * * Display Name: AIPrompt
7482
+ * * SQL Data Type: nvarchar(255)
7483
+ */
7484
+ get AIPrompt(): string;
7485
+ /**
7486
+ * * Field Name: AIModel
7487
+ * * Display Name: AIModel
7488
+ * * SQL Data Type: nvarchar(50)
7489
+ */
7490
+ get AIModel(): string;
7491
+ }
6944
7492
  /**
6945
7493
  * Application Entities - strongly typed entity sub-class
6946
7494
  * * Schema: __mj
@@ -8715,6 +9263,7 @@ export declare class CompanyIntegrationRunEntity extends BaseEntity<CompanyInteg
8715
9263
  * * Field Name: RunByUser
8716
9264
  * * Display Name: Run By User
8717
9265
  * * SQL Data Type: nvarchar(100)
9266
+ * * Default Value: null
8718
9267
  */
8719
9268
  get RunByUser(): string;
8720
9269
  }