@memberjunction/core-entities 2.80.1 → 2.82.0

package/dist/generated/entity_subclasses.js

@@ -1220,6 +1220,11 @@ if this limit is exceeded.`),
     *   * Fail
     *   * Warn
         * * Description: Determines how to handle StartingPayloadValidation failures. Fail = reject invalid input, Warn = log warning but proceed.`),
+    DefaultPromptEffortLevel: zod_1.z.number().nullable().describe(`
+        * * Field Name: DefaultPromptEffortLevel
+        * * Display Name: Default Prompt Effort Level
+        * * SQL Data Type: int
+        * * Description: Default effort level for all prompts executed by this agent (1-100, where 1=minimal effort, 100=maximum effort). Takes precedence over individual prompt EffortLevel settings but can be overridden by runtime parameters. Inherited by sub-agents unless explicitly overridden.`),
     Parent: zod_1.z.string().nullable().describe(`
         * * Field Name: Parent
         * * Display Name: Parent
@@ -1805,6 +1810,11 @@ exports.AIPromptSchema = zod_1.z.object({
         * * SQL Data Type: nvarchar(50)
         * * Default Value: All
         * * Description: Types of errors that should trigger failover. Options: All, NetworkOnly, RateLimitOnly, ServiceErrorOnly`),
+    EffortLevel: zod_1.z.number().nullable().describe(`
+        * * Field Name: EffortLevel
+        * * Display Name: Effort Level
+        * * SQL Data Type: int
+        * * Description: Effort level for this specific prompt (1-100, where 1=minimal effort, 100=maximum effort). Higher values request more thorough reasoning and analysis. Can be overridden by agent DefaultPromptEffortLevel or runtime parameters.`),
     Template: zod_1.z.string().describe(`
         * * Field Name: Template
         * * Display Name: Template
@@ -4856,6 +4866,11 @@ exports.EntitySchema = zod_1.z.object({
     *   * Deprecated
     *   * Disabled
         * * Description: Status of the entity. Active: fully functional; Deprecated: functional but generates console warnings when used; Disabled: not available for use even though metadata and physical table remain.`),
+    DisplayName: zod_1.z.string().nullable().describe(`
+        * * Field Name: DisplayName
+        * * Display Name: Display Name
+        * * SQL Data Type: nvarchar(255)
+        * * Description: Optional display name for the entity. If not provided, the entity Name will be used for display purposes.`),
     CodeName: zod_1.z.string().nullable().describe(`
         * * Field Name: CodeName
         * * Display Name: Code Name
@@ -7588,6 +7603,11 @@ each time the agent processes a prompt step.`),
         * * SQL Data Type: bit
         * * Default Value: 0
         * * Description: Indicates whether verbose logging was enabled during this agent execution. When true, detailed decision-making and execution flow was logged.`),
+    EffortLevel: zod_1.z.number().nullable().describe(`
+        * * Field Name: EffortLevel
+        * * Display Name: Effort Level
+        * * SQL Data Type: int
+        * * Description: Effort level that was actually used during this agent run execution (1-100, where 1=minimal effort, 100=maximum effort). This is the resolved effort level after applying the precedence hierarchy: runtime override > agent default > prompt defaults.`),
     Agent: zod_1.z.string().nullable().describe(`
         * * Field Name: Agent
         * * Display Name: Agent
@@ -8271,7 +8291,7 @@ exports.AIModelVendorSchema = zod_1.z.object({
         * * Display Name: Updated At
         * * SQL Data Type: datetimeoffset
         * * Default Value: getutcdate()`),
-    TypeID: zod_1.z.string().nullable().describe(`
+    TypeID: zod_1.z.string().describe(`
         * * Field Name: TypeID
         * * Display Name: Type ID
         * * SQL Data Type: uniqueidentifier
@@ -8285,7 +8305,7 @@ exports.AIModelVendorSchema = zod_1.z.object({
         * * Field Name: Vendor
         * * Display Name: Vendor
         * * SQL Data Type: nvarchar(50)`),
-    Type: zod_1.z.string().nullable().describe(`
+    Type: zod_1.z.string().describe(`
         * * Field Name: Type
         * * Display Name: Type
         * * SQL Data Type: nvarchar(50)`),
@@ -8843,6 +8863,11 @@ exports.AIPromptRunSchema = zod_1.z.object({
         * * Display Name: Model Specific Response Details
         * * SQL Data Type: nvarchar(MAX)
         * * Description: JSON field containing provider-specific response metadata and details not captured in standard fields. Structure varies by AI provider.`),
+    EffortLevel: zod_1.z.number().nullable().describe(`
+        * * Field Name: EffortLevel
+        * * Display Name: Effort Level
+        * * SQL Data Type: int
+        * * Description: Effort level that was actually used during this prompt run execution (1-100, where 1=minimal effort, 100=maximum effort). This is the resolved effort level after applying the precedence hierarchy: runtime override > agent default > prompt default > provider default.`),
     Prompt: zod_1.z.string().describe(`
         * * Field Name: Prompt
         * * Display Name: Prompt
@@ -9660,6 +9685,28 @@ exports.QuerySchema = zod_1.z.object({
         * * SQL Data Type: bit
         * * Default Value: 0
         * * Description: Automatically set to true when the SQL column contains Nunjucks template markers (e.g., {{ paramName }}). This flag is maintained by the QueryEntityServer for performance optimization and discovery purposes. It allows quick filtering of parameterized queries and enables the UI to show parameter inputs only when needed. The system will automatically update this flag when the SQL content changes.`),
+    AuditQueryRuns: zod_1.z.boolean().describe(`
+        * * Field Name: AuditQueryRuns
+        * * Display Name: Audit Query Runs
+        * * SQL Data Type: bit
+        * * Default Value: 0
+        * * Description: When true, all executions of this query will be logged to the Audit Log system for tracking and compliance`),
+    CacheEnabled: zod_1.z.boolean().describe(`
+        * * Field Name: CacheEnabled
+        * * Display Name: Cache Enabled
+        * * SQL Data Type: bit
+        * * Default Value: 0
+        * * Description: When true, query results will be cached in memory with TTL expiration`),
+    CacheTTLMinutes: zod_1.z.number().nullable().describe(`
+        * * Field Name: CacheTTLMinutes
+        * * Display Name: Cache TTL Minutes
+        * * SQL Data Type: int
+        * * Description: Time-to-live in minutes for cached query results. NULL uses default TTL.`),
+    CacheMaxSize: zod_1.z.number().nullable().describe(`
+        * * Field Name: CacheMaxSize
+        * * Display Name: Cache Max Size
+        * * SQL Data Type: int
+        * * Description: Maximum number of cached result sets for this query. NULL uses default size limit.`),
     Category: zod_1.z.string().nullable().describe(`
         * * Field Name: Category
         * * Display Name: Category
@@ -9702,6 +9749,28 @@ exports.QueryCategorySchema = zod_1.z.object({
         * * Display Name: __mj _Updated At
         * * SQL Data Type: datetimeoffset
         * * Default Value: getutcdate()`),
+    DefaultCacheEnabled: zod_1.z.boolean().describe(`
+        * * Field Name: DefaultCacheEnabled
+        * * Display Name: Default Cache Enabled
+        * * SQL Data Type: bit
+        * * Default Value: 0
+        * * Description: Default cache setting for queries in this category`),
+    DefaultCacheTTLMinutes: zod_1.z.number().nullable().describe(`
+        * * Field Name: DefaultCacheTTLMinutes
+        * * Display Name: Default Cache TTL Minutes
+        * * SQL Data Type: int
+        * * Description: Default TTL in minutes for cached results of queries in this category`),
+    DefaultCacheMaxSize: zod_1.z.number().nullable().describe(`
+        * * Field Name: DefaultCacheMaxSize
+        * * Display Name: Default Cache Max Size
+        * * SQL Data Type: int
+        * * Description: Default maximum cache size for queries in this category`),
+    CacheInheritanceEnabled: zod_1.z.boolean().describe(`
+        * * Field Name: CacheInheritanceEnabled
+        * * Display Name: Cache Inheritance Enabled
+        * * SQL Data Type: bit
+        * * Default Value: 1
+        * * Description: When true, queries without cache config will inherit from this category`),
     Parent: zod_1.z.string().nullable().describe(`
         * * Field Name: Parent
         * * Display Name: Parent
@@ -15402,6 +15471,7 @@ let AIAgentEntity = class AIAgentEntity extends core_1.BaseEntity {
     }
     /**
     * Validate() method override for AI Agents entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * DefaultPromptEffortLevel: This rule ensures that the DefaultPromptEffortLevel must always be a value between 1 and 100, inclusive.
     * * MaxExecutionsPerRun: This rule ensures that the maximum number of executions per run can either be left blank (unspecified) or, if provided, it must be a positive number greater than zero.
     * * MinExecutionsPerRun: This rule ensures that if the minimum executions per run value is provided, it must be zero or greater.
     * * Table-Level: This rule ensures that if context compression is enabled, all related settings (message threshold, prompt ID, and message retention count) must be specified. If context compression is not enabled, these settings may be left unspecified.
@@ -15413,6 +15483,7 @@ let AIAgentEntity = class AIAgentEntity extends core_1.BaseEntity {
     */
     Validate() {
         const result = super.Validate();
+        this.ValidateDefaultPromptEffortLevelWithinRange(result);
         this.ValidateMaxExecutionsPerRunIsNullOrPositive(result);
         this.ValidateMinExecutionsPerRunIsNonNegative(result);
         this.ValidateEnableContextCompressionRequiresContextFields(result);
@@ -15421,6 +15492,17 @@ let AIAgentEntity = class AIAgentEntity extends core_1.BaseEntity {
         return result;
     }
     /**
+    * This rule ensures that the DefaultPromptEffortLevel must always be a value between 1 and 100, inclusive.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateDefaultPromptEffortLevelWithinRange(result) {
+        if (this.DefaultPromptEffortLevel < 1 || this.DefaultPromptEffortLevel > 100) {
+            result.Errors.push(new core_1.ValidationErrorInfo("DefaultPromptEffortLevel", "DefaultPromptEffortLevel must be between 1 and 100.", this.DefaultPromptEffortLevel, core_1.ValidationErrorType.Failure));
+        }
+    }
+    /**
     * This rule ensures that the maximum number of executions per run can either be left blank (unspecified) or, if provided, it must be a positive number greater than zero.
     * @param result - the ValidationResult object to add any errors or warnings to
     * @public
@@ -15935,6 +16017,18 @@ if this limit is exceeded.
         this.Set('StartingPayloadValidationMode', value);
     }
     /**
+    * * Field Name: DefaultPromptEffortLevel
+    * * Display Name: Default Prompt Effort Level
+    * * SQL Data Type: int
+    * * Description: Default effort level for all prompts executed by this agent (1-100, where 1=minimal effort, 100=maximum effort). Takes precedence over individual prompt EffortLevel settings but can be overridden by runtime parameters. Inherited by sub-agents unless explicitly overridden.
+    */
+    get DefaultPromptEffortLevel() {
+        return this.Get('DefaultPromptEffortLevel');
+    }
+    set DefaultPromptEffortLevel(value) {
+        this.Set('DefaultPromptEffortLevel', value);
+    }
+    /**
     * * Field Name: Parent
     * * Display Name: Parent
     * * SQL Data Type: nvarchar(255)
@@ -16662,6 +16756,7 @@ let AIPromptEntity = class AIPromptEntity extends core_1.BaseEntity {
     * Validate() method override for AI Prompts entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * CacheSimilarityThreshold: This rule ensures that if a cache similarity threshold is provided, it must be a value between 0 and 1, inclusive. If no value is provided, that's also allowed.
     * * CacheTTLSeconds: This rule ensures that if the cache expiration time in seconds is provided, it must be greater than zero.
+    * * EffortLevel: This rule ensures that the EffortLevel must be a value between 1 and 100, inclusive.
     * * FailoverErrorScope: This rule ensures that the FailoverErrorScope field can only be set to 'ServiceErrorOnly', 'RateLimitOnly', 'NetworkOnly', 'All', or left empty.
     * * FailoverModelStrategy: This rule ensures that the value for FailoverModelStrategy is either 'RequireSameModel', 'PreferDifferentModel', 'PreferSameModel', or left blank (not set). Any other value is not allowed.
     * * FailoverStrategy: This rule ensures that the FailoverStrategy field, if specified, must be either 'None', 'PowerRank', 'NextBestModel', 'SameModelDifferentVendor', or left blank (unset).
@@ -16678,6 +16773,7 @@ let AIPromptEntity = class AIPromptEntity extends core_1.BaseEntity {
         const result = super.Validate();
         this.ValidateCacheSimilarityThresholdIsBetweenZeroAndOne(result);
         this.ValidateCacheTTLSecondsGreaterThanZero(result);
+        this.ValidateEffortLevelIsWithinRange(result);
         this.ValidateFailoverErrorScopeAgainstAllowedValues(result);
         this.ValidateFailoverModelStrategyAgainstAllowedValues(result);
         this.ValidateFailoverStrategyAllowedValues(result);
@@ -16711,6 +16807,17 @@ let AIPromptEntity = class AIPromptEntity extends core_1.BaseEntity {
         }
     }
     /**
+    * This rule ensures that the EffortLevel must be a value between 1 and 100, inclusive.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateEffortLevelIsWithinRange(result) {
+        if (this.EffortLevel < 1 || this.EffortLevel > 100) {
+            result.Errors.push(new core_1.ValidationErrorInfo("EffortLevel", "EffortLevel must be between 1 and 100.", this.EffortLevel, core_1.ValidationErrorType.Failure));
+        }
+    }
+    /**
     * This rule ensures that the FailoverErrorScope field can only be set to 'ServiceErrorOnly', 'RateLimitOnly', 'NetworkOnly', 'All', or left empty.
     * @param result - the ValidationResult object to add any errors or warnings to
     * @public
@@ -17490,6 +17597,18 @@ let AIPromptEntity = class AIPromptEntity extends core_1.BaseEntity {
         this.Set('FailoverErrorScope', value);
     }
     /**
+    * * Field Name: EffortLevel
+    * * Display Name: Effort Level
+    * * SQL Data Type: int
+    * * Description: Effort level for this specific prompt (1-100, where 1=minimal effort, 100=maximum effort). Higher values request more thorough reasoning and analysis. Can be overridden by agent DefaultPromptEffortLevel or runtime parameters.
+    */
+    get EffortLevel() {
+        return this.Get('EffortLevel');
+    }
+    set EffortLevel(value) {
+        this.Set('EffortLevel', value);
+    }
+    /**
     * * Field Name: Template
     * * Display Name: Template
     * * SQL Data Type: nvarchar(255)
@@ -25290,6 +25409,18 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
         this.Set('Status', value);
     }
     /**
+    * * Field Name: DisplayName
+    * * Display Name: Display Name
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Optional display name for the entity. If not provided, the entity Name will be used for display purposes.
+    */
+    get DisplayName() {
+        return this.Get('DisplayName');
+    }
+    set DisplayName(value) {
+        this.Set('DisplayName', value);
+    }
+    /**
     * * Field Name: CodeName
     * * Display Name: Code Name
     * * SQL Data Type: nvarchar(MAX)
@@ -31582,6 +31713,29 @@ let AIAgentRunEntity = class AIAgentRunEntity extends core_1.BaseEntity {
         return await super.InnerLoad(compositeKey, EntityRelationshipsToLoad);
     }
     /**
+    * Validate() method override for MJ: AI Agent Runs entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * EffortLevel: This rule ensures that the EffortLevel must be a value between 1 and 100, inclusive.
+    * @public
+    * @method
+    * @override
+    */
+    Validate() {
+        const result = super.Validate();
+        this.ValidateEffortLevelWithinAllowedRange(result);
+        return result;
+    }
+    /**
+    * This rule ensures that the EffortLevel must be a value between 1 and 100, inclusive.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateEffortLevelWithinAllowedRange(result) {
+        if (this.EffortLevel < 1 || this.EffortLevel > 100) {
+            result.Errors.push(new core_1.ValidationErrorInfo("EffortLevel", "EffortLevel must be between 1 and 100.", this.EffortLevel, core_1.ValidationErrorType.Failure));
+        }
+    }
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -32046,6 +32200,18 @@ each time the agent processes a prompt step.
         this.Set('Verbose', value);
     }
     /**
+    * * Field Name: EffortLevel
+    * * Display Name: Effort Level
+    * * SQL Data Type: int
+    * * Description: Effort level that was actually used during this agent run execution (1-100, where 1=minimal effort, 100=maximum effort). This is the resolved effort level after applying the precedence hierarchy: runtime override > agent default > prompt defaults.
+    */
+    get EffortLevel() {
+        return this.Get('EffortLevel');
+    }
+    set EffortLevel(value) {
+        this.Set('EffortLevel', value);
+    }
+    /**
     * * Field Name: Agent
     * * Display Name: Agent
     * * SQL Data Type: nvarchar(255)
@@ -34323,6 +34489,7 @@ let AIPromptRunEntity = class AIPromptRunEntity extends core_1.BaseEntity {
     }
     /**
     * Validate() method override for MJ: AI Prompt Runs entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * EffortLevel: This rule ensures that the effort level must be a number between 1 and 100, inclusive.
     * * Table-Level: This rule ensures that if the 'CompletedAt' field has a value, it must be on or after the 'RunAt' field. Otherwise, if 'CompletedAt' is empty, there is no restriction.
     * * Table-Level: This rule ensures that either both TokensPrompt and TokensCompletion are missing, or TokensUsed is missing, or, if all values are present, the value of TokensUsed equals the sum of TokensPrompt and TokensCompletion.
     * @public
@@ -34331,11 +34498,23 @@ let AIPromptRunEntity = class AIPromptRunEntity extends core_1.BaseEntity {
     */
     Validate() {
         const result = super.Validate();
+        this.ValidateEffortLevelWithinRange(result);
         this.ValidateCompletedAtIsNullOrAfterRunAt(result);
         this.ValidateTokensUsedSumMatchesPromptAndCompletion(result);
         return result;
     }
     /**
+    * This rule ensures that the effort level must be a number between 1 and 100, inclusive.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateEffortLevelWithinRange(result) {
+        if (this.EffortLevel < 1 || this.EffortLevel > 100) {
+            result.Errors.push(new core_1.ValidationErrorInfo("EffortLevel", "EffortLevel must be between 1 and 100.", this.EffortLevel, core_1.ValidationErrorType.Failure));
+        }
+    }
+    /**
     * This rule ensures that if the 'CompletedAt' field has a value, it must be on or after the 'RunAt' field. Otherwise, if 'CompletedAt' is empty, there is no restriction.
     * @param result - the ValidationResult object to add any errors or warnings to
     * @public
@@ -35352,6 +35531,18 @@ let AIPromptRunEntity = class AIPromptRunEntity extends core_1.BaseEntity {
         this.Set('ModelSpecificResponseDetails', value);
     }
     /**
+    * * Field Name: EffortLevel
+    * * Display Name: Effort Level
+    * * SQL Data Type: int
+    * * Description: Effort level that was actually used during this prompt run execution (1-100, where 1=minimal effort, 100=maximum effort). This is the resolved effort level after applying the precedence hierarchy: runtime override > agent default > prompt default > provider default.
+    */
+    get EffortLevel() {
+        return this.Get('EffortLevel');
+    }
+    set EffortLevel(value) {
+        this.Set('EffortLevel', value);
+    }
+    /**
     * * Field Name: Prompt
     * * Display Name: Prompt
     * * SQL Data Type: nvarchar(255)
@@ -37656,6 +37847,56 @@ let QueryEntity = class QueryEntity extends core_1.BaseEntity {
         this.Set('UsesTemplate', value);
     }
     /**
+    * * Field Name: AuditQueryRuns
+    * * Display Name: Audit Query Runs
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: When true, all executions of this query will be logged to the Audit Log system for tracking and compliance
+    */
+    get AuditQueryRuns() {
+        return this.Get('AuditQueryRuns');
+    }
+    set AuditQueryRuns(value) {
+        this.Set('AuditQueryRuns', value);
+    }
+    /**
+    * * Field Name: CacheEnabled
+    * * Display Name: Cache Enabled
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: When true, query results will be cached in memory with TTL expiration
+    */
+    get CacheEnabled() {
+        return this.Get('CacheEnabled');
+    }
+    set CacheEnabled(value) {
+        this.Set('CacheEnabled', value);
+    }
+    /**
+    * * Field Name: CacheTTLMinutes
+    * * Display Name: Cache TTL Minutes
+    * * SQL Data Type: int
+    * * Description: Time-to-live in minutes for cached query results. NULL uses default TTL.
+    */
+    get CacheTTLMinutes() {
+        return this.Get('CacheTTLMinutes');
+    }
+    set CacheTTLMinutes(value) {
+        this.Set('CacheTTLMinutes', value);
+    }
+    /**
+    * * Field Name: CacheMaxSize
+    * * Display Name: Cache Max Size
+    * * SQL Data Type: int
+    * * Description: Maximum number of cached result sets for this query. NULL uses default size limit.
+    */
+    get CacheMaxSize() {
+        return this.Get('CacheMaxSize');
+    }
+    set CacheMaxSize(value) {
+        this.Set('CacheMaxSize', value);
+    }
+    /**
     * * Field Name: Category
     * * Display Name: Category
     * * SQL Data Type: nvarchar(50)
@@ -37773,6 +38014,56 @@ let QueryCategoryEntity = class QueryCategoryEntity extends core_1.BaseEntity {
         return this.Get('__mj_UpdatedAt');
     }
     /**
+    * * Field Name: DefaultCacheEnabled
+    * * Display Name: Default Cache Enabled
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Default cache setting for queries in this category
+    */
+    get DefaultCacheEnabled() {
+        return this.Get('DefaultCacheEnabled');
+    }
+    set DefaultCacheEnabled(value) {
+        this.Set('DefaultCacheEnabled', value);
+    }
+    /**
+    * * Field Name: DefaultCacheTTLMinutes
+    * * Display Name: Default Cache TTL Minutes
+    * * SQL Data Type: int
+    * * Description: Default TTL in minutes for cached results of queries in this category
+    */
+    get DefaultCacheTTLMinutes() {
+        return this.Get('DefaultCacheTTLMinutes');
+    }
+    set DefaultCacheTTLMinutes(value) {
+        this.Set('DefaultCacheTTLMinutes', value);
+    }
+    /**
+    * * Field Name: DefaultCacheMaxSize
+    * * Display Name: Default Cache Max Size
+    * * SQL Data Type: int
+    * * Description: Default maximum cache size for queries in this category
+    */
+    get DefaultCacheMaxSize() {
+        return this.Get('DefaultCacheMaxSize');
+    }
+    set DefaultCacheMaxSize(value) {
+        this.Set('DefaultCacheMaxSize', value);
+    }
+    /**
+    * * Field Name: CacheInheritanceEnabled
+    * * Display Name: Cache Inheritance Enabled
+    * * SQL Data Type: bit
+    * * Default Value: 1
+    * * Description: When true, queries without cache config will inherit from this category
+    */
+    get CacheInheritanceEnabled() {
+        return this.Get('CacheInheritanceEnabled');
+    }
+    set CacheInheritanceEnabled(value) {
+        this.Set('CacheInheritanceEnabled', value);
+    }
+    /**
     * * Field Name: Parent
     * * Display Name: Parent
     * * SQL Data Type: nvarchar(50)