@memberjunction/core-entities 2.68.0 → 2.69.1

package/dist/generated/entity_subclasses.d.ts

@@ -432,6 +432,8 @@ export declare const AIAgentActionSchema: z.ZodObject<{
     Status: z.ZodUnion<[z.ZodLiteral<"Pending">, z.ZodLiteral<"Active">, z.ZodLiteral<"Revoked">]>;
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
+    MinExecutionsPerRun: z.ZodNullable<z.ZodNumber>;
+    MaxExecutionsPerRun: z.ZodNullable<z.ZodNumber>;
     Agent: z.ZodNullable<z.ZodString>;
     Action: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
@@ -442,6 +444,8 @@ export declare const AIAgentActionSchema: z.ZodObject<{
     Action?: string;
     Status?: "Active" | "Pending" | "Revoked";
     AgentID?: string;
+    MinExecutionsPerRun?: number;
+    MaxExecutionsPerRun?: number;
     Agent?: string;
 }, {
     ID?: string;
@@ -451,6 +455,8 @@ export declare const AIAgentActionSchema: z.ZodObject<{
     Action?: string;
     Status?: "Active" | "Pending" | "Revoked";
     AgentID?: string;
+    MinExecutionsPerRun?: number;
+    MaxExecutionsPerRun?: number;
     Agent?: string;
 }>;
 export type AIAgentActionEntityType = z.infer<typeof AIAgentActionSchema>;
@@ -668,6 +674,16 @@ export declare const AIAgentSchema: z.ZodObject<{
     PayloadUpstreamPaths: z.ZodString;
     PayloadSelfReadPaths: z.ZodNullable<z.ZodString>;
     PayloadSelfWritePaths: z.ZodNullable<z.ZodString>;
+    PayloadScope: z.ZodNullable<z.ZodString>;
+    FinalPayloadValidation: z.ZodNullable<z.ZodString>;
+    FinalPayloadValidationMode: z.ZodUnion<[z.ZodLiteral<"Retry">, z.ZodLiteral<"Fail">, z.ZodLiteral<"Warn">]>;
+    FinalPayloadValidationMaxRetries: z.ZodNumber;
+    MaxCostPerRun: z.ZodNullable<z.ZodNumber>;
+    MaxTokensPerRun: z.ZodNullable<z.ZodNumber>;
+    MaxIterationsPerRun: z.ZodNullable<z.ZodNumber>;
+    MaxTimePerRun: z.ZodNullable<z.ZodNumber>;
+    MinExecutionsPerRun: z.ZodNullable<z.ZodNumber>;
+    MaxExecutionsPerRun: z.ZodNullable<z.ZodNumber>;
     Parent: z.ZodNullable<z.ZodString>;
     ContextCompressionPrompt: z.ZodNullable<z.ZodString>;
     Type: z.ZodNullable<z.ZodString>;
@@ -683,6 +699,8 @@ export declare const AIAgentSchema: z.ZodObject<{
     Type?: string;
     DriverClass?: string;
     IconClass?: string;
+    MinExecutionsPerRun?: number;
+    MaxExecutionsPerRun?: number;
     LogoURL?: string;
     ExposeAsAction?: boolean;
     ExecutionOrder?: number;
@@ -697,6 +715,14 @@ export declare const AIAgentSchema: z.ZodObject<{
     PayloadUpstreamPaths?: string;
     PayloadSelfReadPaths?: string;
     PayloadSelfWritePaths?: string;
+    PayloadScope?: string;
+    FinalPayloadValidation?: string;
+    FinalPayloadValidationMode?: "Retry" | "Fail" | "Warn";
+    FinalPayloadValidationMaxRetries?: number;
+    MaxCostPerRun?: number;
+    MaxTokensPerRun?: number;
+    MaxIterationsPerRun?: number;
+    MaxTimePerRun?: number;
     ContextCompressionPrompt?: string;
 }, {
     ID?: string;
@@ -710,6 +736,8 @@ export declare const AIAgentSchema: z.ZodObject<{
     Type?: string;
     DriverClass?: string;
     IconClass?: string;
+    MinExecutionsPerRun?: number;
+    MaxExecutionsPerRun?: number;
     LogoURL?: string;
     ExposeAsAction?: boolean;
     ExecutionOrder?: number;
@@ -724,6 +752,14 @@ export declare const AIAgentSchema: z.ZodObject<{
     PayloadUpstreamPaths?: string;
     PayloadSelfReadPaths?: string;
     PayloadSelfWritePaths?: string;
+    PayloadScope?: string;
+    FinalPayloadValidation?: string;
+    FinalPayloadValidationMode?: "Retry" | "Fail" | "Warn";
+    FinalPayloadValidationMaxRetries?: number;
+    MaxCostPerRun?: number;
+    MaxTokensPerRun?: number;
+    MaxIterationsPerRun?: number;
+    MaxTimePerRun?: number;
     ContextCompressionPrompt?: string;
 }>;
 export type AIAgentEntityType = z.infer<typeof AIAgentSchema>;
@@ -982,7 +1018,7 @@ export declare const AIPromptSchema: z.ZodObject<{
     ParallelConfigParam?: string;
     OutputType?: "string" | "number" | "boolean" | "object" | "date";
     OutputExample?: string;
-    ValidationBehavior?: "None" | "Strict" | "Warn";
+    ValidationBehavior?: "Warn" | "None" | "Strict";
     MaxRetries?: number;
     RetryDelayMS?: number;
     RetryStrategy?: "Fixed" | "Exponential" | "Linear";
@@ -1038,7 +1074,7 @@ export declare const AIPromptSchema: z.ZodObject<{
     ParallelConfigParam?: string;
     OutputType?: "string" | "number" | "boolean" | "object" | "date";
     OutputExample?: string;
-    ValidationBehavior?: "None" | "Strict" | "Warn";
+    ValidationBehavior?: "Warn" | "None" | "Strict";
     MaxRetries?: number;
     RetryDelayMS?: number;
     RetryStrategy?: "Fixed" | "Exponential" | "Linear";
@@ -4667,6 +4703,8 @@ export declare const AIAgentRunStepSchema: z.ZodObject<{
     TargetLogID: z.ZodNullable<z.ZodString>;
     PayloadAtStart: z.ZodNullable<z.ZodString>;
     PayloadAtEnd: z.ZodNullable<z.ZodString>;
+    FinalPayloadValidationResult: z.ZodNullable<z.ZodString>;
+    FinalPayloadValidationMessages: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -4686,6 +4724,8 @@ export declare const AIAgentRunStepSchema: z.ZodObject<{
     TargetLogID?: string;
     PayloadAtStart?: string;
     PayloadAtEnd?: string;
+    FinalPayloadValidationResult?: string;
+    FinalPayloadValidationMessages?: string;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -4705,6 +4745,8 @@ export declare const AIAgentRunStepSchema: z.ZodObject<{
     TargetLogID?: string;
     PayloadAtStart?: string;
     PayloadAtEnd?: string;
+    FinalPayloadValidationResult?: string;
+    FinalPayloadValidationMessages?: string;
 }>;
 export type AIAgentRunStepEntityType = z.infer<typeof AIAgentRunStepSchema>;
 /**
@@ -4741,6 +4783,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     Message: z.ZodNullable<z.ZodString>;
     LastRunID: z.ZodNullable<z.ZodString>;
     StartingPayload: z.ZodNullable<z.ZodString>;
+    TotalPromptIterations: z.ZodNumber;
     Agent: z.ZodNullable<z.ZodString>;
     Conversation: z.ZodNullable<z.ZodString>;
     User: z.ZodNullable<z.ZodString>;
@@ -4775,9 +4818,10 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     ConversationDetailID?: string;
     ConversationDetailSequence?: number;
     CancellationReason?: "System" | "User Request" | "Timeout";
-    FinalStep?: "Failed" | "Success" | "Actions" | "Sub-Agent" | "Chat" | "Retry";
+    FinalStep?: "Failed" | "Retry" | "Success" | "Actions" | "Sub-Agent" | "Chat";
     FinalPayload?: string;
     StartingPayload?: string;
+    TotalPromptIterations?: number;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -4809,9 +4853,10 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     ConversationDetailID?: string;
     ConversationDetailSequence?: number;
     CancellationReason?: "System" | "User Request" | "Timeout";
-    FinalStep?: "Failed" | "Success" | "Actions" | "Sub-Agent" | "Chat" | "Retry";
+    FinalStep?: "Failed" | "Retry" | "Success" | "Actions" | "Sub-Agent" | "Chat";
     FinalPayload?: string;
     StartingPayload?: string;
+    TotalPromptIterations?: number;
 }>;
 export type AIAgentRunEntityType = z.infer<typeof AIAgentRunSchema>;
 /**
@@ -9186,6 +9231,37 @@ export declare class AIAgentActionEntity extends BaseEntity<AIAgentActionEntityT
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * Validate() method override for AI Agent Actions entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * MaxExecutionsPerRun: This rule ensures that if a value for the maximum number of executions per run is provided, it must be greater than zero. If no value is provided, that's acceptable.
+    * * Table-Level: This rule ensures that the minimum number of executions per run cannot be greater than the maximum number of executions per run. If either value is not specified, the rule is considered satisfied.
+    * * MinExecutionsPerRun: This rule ensures that if a value for 'Minimum Executions Per Run' is provided, it must be zero or greater. If the value is not provided (left blank), that's also allowed.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that if a value for the maximum number of executions per run is provided, it must be greater than zero. If no value is provided, that's acceptable.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateMaxExecutionsPerRunGreaterThanZero(result: ValidationResult): void;
+    /**
+    * This rule ensures that the minimum number of executions per run cannot be greater than the maximum number of executions per run. If either value is not specified, the rule is considered satisfied.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateMinExecutionsPerRunLessThanOrEqualToMax(result: ValidationResult): void;
+    /**
+    * This rule ensures that if a value for 'Minimum Executions Per Run' is provided, it must be zero or greater. If the value is not provided (left blank), that's also allowed.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateMinExecutionsPerRunIsNonNegative(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -9240,6 +9316,22 @@ export declare class AIAgentActionEntity extends BaseEntity<AIAgentActionEntityT
     */
     get __mj_UpdatedAt(): Date;
     /**
+    * * Field Name: MinExecutionsPerRun
+    * * Display Name: Min Executions Per Run
+    * * SQL Data Type: int
+    * * Description: Minimum number of times this action must be executed per agent run
+    */
+    get MinExecutionsPerRun(): number | null;
+    set MinExecutionsPerRun(value: number | null);
+    /**
+    * * Field Name: MaxExecutionsPerRun
+    * * Display Name: Max Executions Per Run
+    * * SQL Data Type: int
+    * * Description: Maximum number of times this action can be executed per agent run
+    */
+    get MaxExecutionsPerRun(): number | null;
+    set MaxExecutionsPerRun(value: number | null);
+    /**
     * * Field Name: Agent
     * * Display Name: Agent
     * * SQL Data Type: nvarchar(255)
@@ -9790,6 +9882,9 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
     * 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:
     * * Table-Level: This rule makes sure that if the ParentID is set (not empty), then the ExposeAsAction option must be disabled. If ExposeAsAction is enabled, ParentID must be empty.
     * * 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.
+    * * 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 both 'Minimum Executions Per Run' and 'Maximum Executions Per Run' are specified, the minimum must not be greater than the maximum. If either field is not specified, this rule does not apply.
+    * * 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.
     * @public
     * @method
     * @override
@@ -9810,6 +9905,27 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
     */
     ValidateEnableContextCompressionRequiresContextFields(result: ValidationResult): void;
     /**
+    * This rule ensures that if the minimum executions per run value is provided, it must be zero or greater.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateMinExecutionsPerRunIsNonNegative(result: ValidationResult): void;
+    /**
+    * This rule ensures that if both 'Minimum Executions Per Run' and 'Maximum Executions Per Run' are specified, the minimum must not be greater than the maximum. If either field is not specified, this rule does not apply.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateMinExecutionsPerRunLessThanOrEqualToMaxExecutionsPerRun(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
+    * @method
+    */
+    ValidateMaxExecutionsPerRunIsNullOrPositive(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -10012,6 +10128,98 @@ data flow when the agent executes its own prompt step.
     get PayloadSelfWritePaths(): string | null;
     set PayloadSelfWritePaths(value: string | null);
     /**
+    * * Field Name: PayloadScope
+    * * Display Name: Payload Scope
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Defines the scope/path within the parent payload that this sub-agent operates on. When set, the sub-agent receives only this portion of the payload and all change requests are relative to this scope. Format: /path/to/scope (e.g. /PropA/SubProp1)
+    */
+    get PayloadScope(): string | null;
+    set PayloadScope(value: string | null);
+    /**
+    * * Field Name: FinalPayloadValidation
+    * * Display Name: Final Payload Validation
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Optional JSON schema or requirements that define the expected structure and content of the agent's final payload. Used to validate the output when the agent declares success. Similar to OutputExample in AI Prompts.
+    */
+    get FinalPayloadValidation(): string | null;
+    set FinalPayloadValidation(value: string | null);
+    /**
+    * * Field Name: FinalPayloadValidationMode
+    * * Display Name: Final Payload Validation Mode
+    * * SQL Data Type: nvarchar(25)
+    * * Default Value: Retry
+    * * Value List Type: List
+    * * Possible Values
+    *   * Retry
+    *   * Fail
+    *   * Warn
+    * * Description: Determines how to handle validation failures when FinalPayloadValidation is specified. Options: Retry (default) - retry the agent with validation feedback, Fail - fail the agent run immediately, Warn - log a warning but allow success.
+    */
+    get FinalPayloadValidationMode(): 'Retry' | 'Fail' | 'Warn';
+    set FinalPayloadValidationMode(value: 'Retry' | 'Fail' | 'Warn');
+    /**
+    * * Field Name: FinalPayloadValidationMaxRetries
+    * * Display Name: Final Payload Validation Max Retries
+    * * SQL Data Type: int
+    * * Default Value: 3
+    * * Description: Maximum number of retry attempts allowed when FinalPayloadValidation fails with
+Retry mode. After reaching this limit, the validation will fail permanently.
+    */
+    get FinalPayloadValidationMaxRetries(): number;
+    set FinalPayloadValidationMaxRetries(value: number);
+    /**
+    * * Field Name: MaxCostPerRun
+    * * Display Name: Max Cost Per Run
+    * * SQL Data Type: decimal(10, 4)
+    * * Description: Maximum cost in dollars allowed for a single agent run. Run will be terminated
+  if this limit is exceeded.
+    */
+    get MaxCostPerRun(): number | null;
+    set MaxCostPerRun(value: number | null);
+    /**
+    * * Field Name: MaxTokensPerRun
+    * * Display Name: Max Tokens Per Run
+    * * SQL Data Type: int
+    * * Description: Maximum total tokens (input + output) allowed for a single agent run. Run will
+  be terminated if this limit is exceeded.
+    */
+    get MaxTokensPerRun(): number | null;
+    set MaxTokensPerRun(value: number | null);
+    /**
+    * * Field Name: MaxIterationsPerRun
+    * * Display Name: Max Iterations Per Run
+    * * SQL Data Type: int
+    * * Description: Maximum number of prompt iterations allowed for a single agent run. Run will be
+   terminated if this limit is exceeded.
+    */
+    get MaxIterationsPerRun(): number | null;
+    set MaxIterationsPerRun(value: number | null);
+    /**
+    * * Field Name: MaxTimePerRun
+    * * Display Name: Max Time Per Run
+    * * SQL Data Type: int
+    * * Description: Maximum time in seconds allowed for a single agent run. Run will be terminated
+  if this limit is exceeded.
+    */
+    get MaxTimePerRun(): number | null;
+    set MaxTimePerRun(value: number | null);
+    /**
+    * * Field Name: MinExecutionsPerRun
+    * * Display Name: Min Executions Per Run
+    * * SQL Data Type: int
+    * * Description: When acting as a sub-agent, minimum number of times this agent must be executed per parent agent run
+    */
+    get MinExecutionsPerRun(): number | null;
+    set MinExecutionsPerRun(value: number | null);
+    /**
+    * * Field Name: MaxExecutionsPerRun
+    * * Display Name: Max Executions Per Run
+    * * SQL Data Type: int
+    * * Description: When acting as a sub-agent, maximum number of times this agent can be executed per parent agent run
+    */
+    get MaxExecutionsPerRun(): number | null;
+    set MaxExecutionsPerRun(value: number | null);
+    /**
     * * Field Name: Parent
     * * Display Name: Parent
     * * SQL Data Type: nvarchar(255)
@@ -20658,6 +20866,7 @@ export declare class AIAgentRunStepEntity extends BaseEntity<AIAgentRunStepEntit
     /**
     * Validate() method override for MJ: AI Agent Run Steps entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * StepNumber: This rule ensures that the step number must always be greater than zero.
+    * * FinalPayloadValidationResult: This rule ensures that the FinalPayloadValidationResult field is either left blank or is set to one of the following values: 'Warn', 'Fail', 'Retry', or 'Pass'. No other values are allowed.
     * @public
     * @method
     * @override
@@ -20671,6 +20880,13 @@ export declare class AIAgentRunStepEntity extends BaseEntity<AIAgentRunStepEntit
     */
     ValidateStepNumberGreaterThanZero(result: ValidationResult): void;
     /**
+    * This rule ensures that the FinalPayloadValidationResult field is either left blank or is set to one of the following values: 'Warn', 'Fail', 'Retry', or 'Pass'. No other values are allowed.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateFinalPayloadValidationResultAllowedValues(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -20831,6 +21047,25 @@ export declare class AIAgentRunStepEntity extends BaseEntity<AIAgentRunStepEntit
     */
     get PayloadAtEnd(): string | null;
     set PayloadAtEnd(value: string | null);
+    /**
+    * * Field Name: FinalPayloadValidationResult
+    * * Display Name: Final Payload Validation Result
+    * * SQL Data Type: nvarchar(25)
+    * * Description: Result of the final payload validation for this step. Pass indicates successful
+validation, Retry means validation failed but will retry, Fail means validation failed
+permanently, Warn means validation failed but execution continues.
+    */
+    get FinalPayloadValidationResult(): string | null;
+    set FinalPayloadValidationResult(value: string | null);
+    /**
+    * * Field Name: FinalPayloadValidationMessages
+    * * Display Name: Final Payload Validation Messages
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Validation error messages or warnings from final payload validation. Contains
+detailed information about what validation rules failed.
+    */
+    get FinalPayloadValidationMessages(): string | null;
+    set FinalPayloadValidationMessages(value: string | null);
 }
 /**
  * MJ: AI Agent Runs - strongly typed entity sub-class
@@ -21127,6 +21362,16 @@ export declare class AIAgentRunEntity extends BaseEntity<AIAgentRunEntityType> {
     get StartingPayload(): string | null;
     set StartingPayload(value: string | null);
     /**
+    * * Field Name: TotalPromptIterations
+    * * Display Name: Total Prompt Iterations
+    * * SQL Data Type: int
+    * * Default Value: 0
+    * * Description: Total number of prompt iterations executed during this agent run. Incremented
+  each time the agent processes a prompt step.
+    */
+    get TotalPromptIterations(): number;
+    set TotalPromptIterations(value: number);
+    /**
     * * Field Name: Agent
     * * Display Name: Agent
     * * SQL Data Type: nvarchar(255)