@memberjunction/core-entities 2.80.1 → 2.82.0

package/dist/generated/entity_subclasses.d.ts

@@ -686,6 +686,7 @@ export declare const AIAgentSchema: z.ZodObject<{
     MaxExecutionsPerRun: z.ZodNullable<z.ZodNumber>;
     StartingPayloadValidation: z.ZodNullable<z.ZodString>;
     StartingPayloadValidationMode: z.ZodUnion<[z.ZodLiteral<"Fail">, z.ZodLiteral<"Warn">]>;
+    DefaultPromptEffortLevel: z.ZodNullable<z.ZodNumber>;
     Parent: z.ZodNullable<z.ZodString>;
     ContextCompressionPrompt: z.ZodNullable<z.ZodString>;
     Type: z.ZodNullable<z.ZodString>;
@@ -727,6 +728,7 @@ export declare const AIAgentSchema: z.ZodObject<{
     MaxTimePerRun?: number;
     StartingPayloadValidation?: string;
     StartingPayloadValidationMode?: "Fail" | "Warn";
+    DefaultPromptEffortLevel?: number;
     ContextCompressionPrompt?: string;
 }, {
     ID?: string;
@@ -766,6 +768,7 @@ export declare const AIAgentSchema: z.ZodObject<{
     MaxTimePerRun?: number;
     StartingPayloadValidation?: string;
     StartingPayloadValidationMode?: "Fail" | "Warn";
+    DefaultPromptEffortLevel?: number;
     ContextCompressionPrompt?: string;
 }>;
 export type AIAgentEntityType = z.infer<typeof AIAgentSchema>;
@@ -995,6 +998,7 @@ export declare const AIPromptSchema: z.ZodObject<{
     FailoverDelaySeconds: z.ZodNullable<z.ZodNumber>;
     FailoverModelStrategy: z.ZodString;
     FailoverErrorScope: z.ZodString;
+    EffortLevel: z.ZodNullable<z.ZodNumber>;
     Template: z.ZodString;
     Category: z.ZodNullable<z.ZodString>;
     Type: z.ZodString;
@@ -1054,6 +1058,7 @@ export declare const AIPromptSchema: z.ZodObject<{
     FailoverDelaySeconds?: number;
     FailoverModelStrategy?: string;
     FailoverErrorScope?: string;
+    EffortLevel?: number;
     Template?: string;
     ResultSelectorPrompt?: string;
 }, {
@@ -1110,6 +1115,7 @@ export declare const AIPromptSchema: z.ZodObject<{
     FailoverDelaySeconds?: number;
     FailoverModelStrategy?: string;
     FailoverErrorScope?: string;
+    EffortLevel?: number;
     Template?: string;
     ResultSelectorPrompt?: string;
 }>;
@@ -3010,6 +3016,7 @@ export declare const EntitySchema: z.ZodObject<{
     RowCount: z.ZodNullable<z.ZodNumber>;
     RowCountRunAt: z.ZodNullable<z.ZodDate>;
     Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Deprecated">, z.ZodLiteral<"Disabled">]>;
+    DisplayName: z.ZodNullable<z.ZodString>;
     CodeName: z.ZodNullable<z.ZodString>;
     ClassName: z.ZodNullable<z.ZodString>;
     BaseTableCodeName: z.ZodNullable<z.ZodString>;
@@ -3074,6 +3081,7 @@ export declare const EntitySchema: z.ZodObject<{
     AutoRowCountFrequency?: number;
     RowCount?: number;
     RowCountRunAt?: Date;
+    DisplayName?: string;
     ClassName?: string;
     BaseTableCodeName?: string;
     ParentEntity?: string;
@@ -3137,6 +3145,7 @@ export declare const EntitySchema: z.ZodObject<{
     AutoRowCountFrequency?: number;
     RowCount?: number;
     RowCountRunAt?: Date;
+    DisplayName?: string;
     ClassName?: string;
     BaseTableCodeName?: string;
     ParentEntity?: string;
@@ -4795,6 +4804,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     OverrideVendorID: z.ZodNullable<z.ZodString>;
     Data: z.ZodNullable<z.ZodString>;
     Verbose: z.ZodNullable<z.ZodBoolean>;
+    EffortLevel: z.ZodNullable<z.ZodNumber>;
     Agent: z.ZodNullable<z.ZodString>;
     Conversation: z.ZodNullable<z.ZodString>;
     User: z.ZodNullable<z.ZodString>;
@@ -4812,6 +4822,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     User?: string;
     AgentID?: string;
     Agent?: string;
+    EffortLevel?: number;
     ConfigurationID?: string;
     Configuration?: string;
     Success?: boolean;
@@ -4855,6 +4866,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     User?: string;
     AgentID?: string;
     Agent?: string;
+    EffortLevel?: number;
     ConfigurationID?: string;
     Configuration?: string;
     Success?: boolean;
@@ -5269,10 +5281,10 @@ export declare const AIModelVendorSchema: z.ZodObject<{
     SupportsStreaming: z.ZodBoolean;
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
-    TypeID: z.ZodNullable<z.ZodString>;
+    TypeID: z.ZodString;
     Model: z.ZodString;
     Vendor: z.ZodString;
-    Type: z.ZodNullable<z.ZodString>;
+    Type: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -5461,6 +5473,7 @@ export declare const AIPromptRunSchema: z.ZodObject<{
     PromptTime: z.ZodNullable<z.ZodNumber>;
     CompletionTime: z.ZodNullable<z.ZodNumber>;
     ModelSpecificResponseDetails: z.ZodNullable<z.ZodString>;
+    EffortLevel: z.ZodNullable<z.ZodNumber>;
     Prompt: z.ZodString;
     Model: z.ZodString;
     Vendor: z.ZodString;
@@ -5494,6 +5507,7 @@ export declare const AIPromptRunSchema: z.ZodObject<{
     Seed?: number;
     StopSequences?: string;
     TopLogProbs?: number;
+    EffortLevel?: number;
     RunAt?: Date;
     VendorID?: string;
     ConfigurationID?: string;
@@ -5583,6 +5597,7 @@ export declare const AIPromptRunSchema: z.ZodObject<{
     Seed?: number;
     StopSequences?: string;
     TopLogProbs?: number;
+    EffortLevel?: number;
     RunAt?: Date;
     VendorID?: string;
     ConfigurationID?: string;
@@ -6148,6 +6163,10 @@ export declare const QuerySchema: z.ZodObject<{
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
     UsesTemplate: z.ZodNullable<z.ZodBoolean>;
+    AuditQueryRuns: z.ZodBoolean;
+    CacheEnabled: z.ZodBoolean;
+    CacheTTLMinutes: z.ZodNullable<z.ZodNumber>;
+    CacheMaxSize: z.ZodNullable<z.ZodNumber>;
     Category: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
@@ -6166,6 +6185,10 @@ export declare const QuerySchema: z.ZodObject<{
     QualityRank?: number;
     ExecutionCostRank?: number;
     UsesTemplate?: boolean;
+    AuditQueryRuns?: boolean;
+    CacheEnabled?: boolean;
+    CacheTTLMinutes?: number;
+    CacheMaxSize?: number;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -6183,6 +6206,10 @@ export declare const QuerySchema: z.ZodObject<{
     QualityRank?: number;
     ExecutionCostRank?: number;
     UsesTemplate?: boolean;
+    AuditQueryRuns?: boolean;
+    CacheEnabled?: boolean;
+    CacheTTLMinutes?: number;
+    CacheMaxSize?: number;
 }>;
 export type QueryEntityType = z.infer<typeof QuerySchema>;
 /**
@@ -6196,6 +6223,10 @@ export declare const QueryCategorySchema: z.ZodObject<{
     UserID: z.ZodString;
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
+    DefaultCacheEnabled: z.ZodBoolean;
+    DefaultCacheTTLMinutes: z.ZodNullable<z.ZodNumber>;
+    DefaultCacheMaxSize: z.ZodNullable<z.ZodNumber>;
+    CacheInheritanceEnabled: z.ZodBoolean;
     Parent: z.ZodNullable<z.ZodString>;
     User: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -6208,6 +6239,10 @@ export declare const QueryCategorySchema: z.ZodObject<{
     Parent?: string;
     UserID?: string;
     User?: string;
+    DefaultCacheEnabled?: boolean;
+    DefaultCacheTTLMinutes?: number;
+    DefaultCacheMaxSize?: number;
+    CacheInheritanceEnabled?: boolean;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -6218,6 +6253,10 @@ export declare const QueryCategorySchema: z.ZodObject<{
     Parent?: string;
     UserID?: string;
     User?: string;
+    DefaultCacheEnabled?: boolean;
+    DefaultCacheTTLMinutes?: number;
+    DefaultCacheMaxSize?: number;
+    CacheInheritanceEnabled?: boolean;
 }>;
 export type QueryCategoryEntityType = z.infer<typeof QueryCategorySchema>;
 /**
@@ -10193,6 +10232,7 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
     * 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.
@@ -10204,6 +10244,13 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
     */
     Validate(): ValidationResult;
     /**
+    * 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: ValidationResult): void;
+    /**
     * 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
@@ -10554,6 +10601,14 @@ if this limit is exceeded.
     get StartingPayloadValidationMode(): 'Fail' | 'Warn';
     set StartingPayloadValidationMode(value: 'Fail' | 'Warn');
     /**
+    * * 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(): number | null;
+    set DefaultPromptEffortLevel(value: number | null);
+    /**
     * * Field Name: Parent
     * * Display Name: Parent
     * * SQL Data Type: nvarchar(255)
@@ -11075,6 +11130,7 @@ export declare class AIPromptEntity extends BaseEntity<AIPromptEntityType> {
     * 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).
@@ -11103,6 +11159,13 @@ export declare class AIPromptEntity extends BaseEntity<AIPromptEntityType> {
     */
     ValidateCacheTTLSecondsGreaterThanZero(result: ValidationResult): void;
     /**
+    * 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: ValidationResult): void;
+    /**
     * 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
@@ -11643,6 +11706,14 @@ export declare class AIPromptEntity extends BaseEntity<AIPromptEntityType> {
     get FailoverErrorScope(): string;
     set FailoverErrorScope(value: string);
     /**
+    * * 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(): number | null;
+    set EffortLevel(value: number | null);
+    /**
     * * Field Name: Template
     * * Display Name: Template
     * * SQL Data Type: nvarchar(255)
@@ -17155,6 +17226,14 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
     get Status(): 'Active' | 'Deprecated' | 'Disabled';
     set Status(value: 'Active' | 'Deprecated' | 'Disabled');
     /**
+    * * 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(): string | null;
+    set DisplayName(value: string | null);
+    /**
     * * Field Name: CodeName
     * * Display Name: Code Name
     * * SQL Data Type: nvarchar(MAX)
@@ -21653,6 +21732,21 @@ export declare class AIAgentRunEntity extends BaseEntity<AIAgentRunEntityType> {
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * 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(): ValidationResult;
+    /**
+    * 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: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -21977,6 +22071,14 @@ each time the agent processes a prompt step.
     get Verbose(): boolean | null;
     set Verbose(value: boolean | null);
     /**
+    * * 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(): number | null;
+    set EffortLevel(value: number | null);
+    /**
     * * Field Name: Agent
     * * Display Name: Agent
     * * SQL Data Type: nvarchar(255)
@@ -23314,8 +23416,8 @@ export declare class AIModelVendorEntity extends BaseEntity<AIModelVendorEntityT
     * * Related Entity/Foreign Key: MJ: AI Vendor Type Definitions (vwAIVendorTypeDefinitions.ID)
     * * Description: References the type/role of the vendor for this model (e.g., model developer, inference provider)
     */
-    get TypeID(): string | null;
-    set TypeID(value: string | null);
+    get TypeID(): string;
+    set TypeID(value: string);
     /**
     * * Field Name: Model
     * * Display Name: Model
@@ -23333,7 +23435,7 @@ export declare class AIModelVendorEntity extends BaseEntity<AIModelVendorEntityT
     * * Display Name: Type
     * * SQL Data Type: nvarchar(50)
     */
-    get Type(): string | null;
+    get Type(): string;
 }
 /**
  * MJ: AI Prompt Models - strongly typed entity sub-class
@@ -23579,6 +23681,7 @@ export declare class AIPromptRunEntity extends BaseEntity<AIPromptRunEntityType>
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
     * 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
@@ -23587,6 +23690,13 @@ export declare class AIPromptRunEntity extends BaseEntity<AIPromptRunEntityType>
     */
     Validate(): ValidationResult;
     /**
+    * 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: ValidationResult): void;
+    /**
     * 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
@@ -24277,6 +24387,14 @@ export declare class AIPromptRunEntity extends BaseEntity<AIPromptRunEntityType>
     get ModelSpecificResponseDetails(): string | null;
     set ModelSpecificResponseDetails(value: string | null);
     /**
+    * * 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(): number | null;
+    set EffortLevel(value: number | null);
+    /**
     * * Field Name: Prompt
     * * Display Name: Prompt
     * * SQL Data Type: nvarchar(255)
@@ -25881,6 +25999,40 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
     get UsesTemplate(): boolean | null;
     set UsesTemplate(value: boolean | null);
     /**
+    * * 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(): boolean;
+    set AuditQueryRuns(value: boolean);
+    /**
+    * * 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(): boolean;
+    set CacheEnabled(value: boolean);
+    /**
+    * * 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(): number | null;
+    set CacheTTLMinutes(value: number | null);
+    /**
+    * * 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(): number | null;
+    set CacheMaxSize(value: number | null);
+    /**
     * * Field Name: Category
     * * Display Name: Category
     * * SQL Data Type: nvarchar(50)
@@ -25964,6 +26116,40 @@ export declare class QueryCategoryEntity extends BaseEntity<QueryCategoryEntityT
     */
     get __mj_UpdatedAt(): Date;
     /**
+    * * 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(): boolean;
+    set DefaultCacheEnabled(value: boolean);
+    /**
+    * * 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(): number | null;
+    set DefaultCacheTTLMinutes(value: number | null);
+    /**
+    * * 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(): number | null;
+    set DefaultCacheMaxSize(value: number | null);
+    /**
+    * * 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(): boolean;
+    set CacheInheritanceEnabled(value: boolean);
+    /**
     * * Field Name: Parent
     * * Display Name: Parent
     * * SQL Data Type: nvarchar(50)