@memberjunction/core-entities 2.76.0 → 2.78.0

package/dist/generated/entity_subclasses.d.ts

@@ -1,4 +1,4 @@
-import { BaseEntity, ValidationResult } from "@memberjunction/core";
+import { BaseEntity, EntityDeleteOptions, ValidationResult } from "@memberjunction/core";
 import { z } from "zod";
 export declare const loadModule: () => void;
 /**
@@ -5418,17 +5418,33 @@ export declare const AIPromptRunSchema: z.ZodObject<{
     OriginalRequestStartTime: z.ZodNullable<z.ZodDate>;
     TotalFailoverDuration: z.ZodNullable<z.ZodNumber>;
     RerunFromPromptRunID: z.ZodNullable<z.ZodString>;
+    ModelSelection: z.ZodNullable<z.ZodString>;
+    Status: z.ZodUnion<[z.ZodLiteral<"Pending">, z.ZodLiteral<"Running">, z.ZodLiteral<"Completed">, z.ZodLiteral<"Failed">, z.ZodLiteral<"Cancelled">]>;
+    Cancelled: z.ZodBoolean;
+    CancellationReason: z.ZodNullable<z.ZodString>;
+    ModelPowerRank: z.ZodNullable<z.ZodNumber>;
+    SelectionStrategy: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"Default">, z.ZodLiteral<"Specific">, z.ZodLiteral<"ByPower">]>>;
+    CacheHit: z.ZodBoolean;
+    CacheKey: z.ZodNullable<z.ZodString>;
+    JudgeID: z.ZodNullable<z.ZodString>;
+    JudgeScore: z.ZodNullable<z.ZodNumber>;
+    WasSelectedResult: z.ZodBoolean;
+    StreamingEnabled: z.ZodBoolean;
+    FirstTokenTime: z.ZodNullable<z.ZodNumber>;
+    ErrorDetails: z.ZodNullable<z.ZodString>;
     Prompt: z.ZodString;
     Model: z.ZodString;
     Vendor: z.ZodString;
     Agent: z.ZodNullable<z.ZodString>;
     Configuration: z.ZodNullable<z.ZodString>;
     OriginalModel: z.ZodNullable<z.ZodString>;
+    Judge: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
     __mj_CreatedAt?: Date;
     __mj_UpdatedAt?: Date;
     ParentID?: string;
+    Status?: "Pending" | "Failed" | "Running" | "Completed" | "Cancelled";
     AgentID?: string;
     Agent?: string;
     ModelID?: string;
@@ -5436,6 +5452,7 @@ export declare const AIPromptRunSchema: z.ZodObject<{
     ExecutionOrder?: number;
     Vendor?: string;
     ResponseFormat?: string;
+    SelectionStrategy?: "Default" | "Specific" | "ByPower";
     ValidationBehavior?: string;
     RetryStrategy?: string;
     Temperature?: number;
@@ -5456,9 +5473,11 @@ export declare const AIPromptRunSchema: z.ZodObject<{
     Prompt?: string;
     PromptID?: string;
     AgentRunID?: string;
+    Cancelled?: boolean;
     CompletedAt?: Date;
     Result?: string;
     TotalCost?: number;
+    CancellationReason?: string;
     ExecutionTimeMS?: number;
     Messages?: string;
     TokensUsed?: number;
@@ -5491,12 +5510,24 @@ export declare const AIPromptRunSchema: z.ZodObject<{
     OriginalRequestStartTime?: Date;
     TotalFailoverDuration?: number;
     RerunFromPromptRunID?: string;
+    ModelSelection?: string;
+    ModelPowerRank?: number;
+    CacheHit?: boolean;
+    CacheKey?: string;
+    JudgeID?: string;
+    JudgeScore?: number;
+    WasSelectedResult?: boolean;
+    StreamingEnabled?: boolean;
+    FirstTokenTime?: number;
+    ErrorDetails?: string;
     OriginalModel?: string;
+    Judge?: string;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
     __mj_UpdatedAt?: Date;
     ParentID?: string;
+    Status?: "Pending" | "Failed" | "Running" | "Completed" | "Cancelled";
     AgentID?: string;
     Agent?: string;
     ModelID?: string;
@@ -5504,6 +5535,7 @@ export declare const AIPromptRunSchema: z.ZodObject<{
     ExecutionOrder?: number;
     Vendor?: string;
     ResponseFormat?: string;
+    SelectionStrategy?: "Default" | "Specific" | "ByPower";
     ValidationBehavior?: string;
     RetryStrategy?: string;
     Temperature?: number;
@@ -5524,9 +5556,11 @@ export declare const AIPromptRunSchema: z.ZodObject<{
     Prompt?: string;
     PromptID?: string;
     AgentRunID?: string;
+    Cancelled?: boolean;
     CompletedAt?: Date;
     Result?: string;
     TotalCost?: number;
+    CancellationReason?: string;
     ExecutionTimeMS?: number;
     Messages?: string;
     TokensUsed?: number;
@@ -5559,7 +5593,18 @@ export declare const AIPromptRunSchema: z.ZodObject<{
     OriginalRequestStartTime?: Date;
     TotalFailoverDuration?: number;
     RerunFromPromptRunID?: string;
+    ModelSelection?: string;
+    ModelPowerRank?: number;
+    CacheHit?: boolean;
+    CacheKey?: string;
+    JudgeID?: string;
+    JudgeScore?: number;
+    WasSelectedResult?: boolean;
+    StreamingEnabled?: boolean;
+    FirstTokenTime?: number;
+    ErrorDetails?: string;
     OriginalModel?: string;
+    Judge?: string;
 }>;
 export type AIPromptRunEntityType = z.infer<typeof AIPromptRunSchema>;
 /**
@@ -14708,6 +14753,16 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * Conversation Details - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof ConversationDetailEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * Validate() method override for Conversation Details entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * UserRating: This rule ensures that the user rating is between 1 and 10, inclusive. Ratings below 1 or above 10 are not allowed.
     * @public
@@ -14910,6 +14965,16 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * Conversations - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof ConversationEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -23937,6 +24002,136 @@ export declare class AIPromptRunEntity extends BaseEntity<AIPromptRunEntityType>
     get RerunFromPromptRunID(): string | null;
     set RerunFromPromptRunID(value: string | null);
     /**
+    * * Field Name: ModelSelection
+    * * Display Name: Model Selection
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON object containing detailed model selection information including all models considered, their scores, and the selection rationale
+    */
+    get ModelSelection(): string | null;
+    set ModelSelection(value: string | null);
+    /**
+    * * Field Name: Status
+    * * Display Name: Status
+    * * SQL Data Type: nvarchar(50)
+    * * Default Value: Pending
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * Running
+    *   * Completed
+    *   * Failed
+    *   * Cancelled
+    * * Description: Current execution status of the prompt run. Valid values: Pending, Running, Completed, Failed, Cancelled
+    */
+    get Status(): 'Pending' | 'Running' | 'Completed' | 'Failed' | 'Cancelled';
+    set Status(value: 'Pending' | 'Running' | 'Completed' | 'Failed' | 'Cancelled');
+    /**
+    * * Field Name: Cancelled
+    * * Display Name: Cancelled
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Indicates whether this prompt run was cancelled before completion
+    */
+    get Cancelled(): boolean;
+    set Cancelled(value: boolean);
+    /**
+    * * Field Name: CancellationReason
+    * * Display Name: Cancellation Reason
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Detailed reason for cancellation if the prompt run was cancelled. Could be user_requested, timeout, error, or resource_limit
+    */
+    get CancellationReason(): string | null;
+    set CancellationReason(value: string | null);
+    /**
+    * * Field Name: ModelPowerRank
+    * * Display Name: Model Power Rank
+    * * SQL Data Type: int
+    * * Description: Power rank of the model that was selected for this run. Lower numbers indicate more powerful models
+    */
+    get ModelPowerRank(): number | null;
+    set ModelPowerRank(value: number | null);
+    /**
+    * * Field Name: SelectionStrategy
+    * * Display Name: Selection Strategy
+    * * SQL Data Type: nvarchar(50)
+    * * Value List Type: List
+    * * Possible Values
+    *   * Default
+    *   * Specific
+    *   * ByPower
+    * * Description: Strategy used for model selection. Valid values: Default (system default), Specific (specific models configured), ByPower (based on power ranking)
+    */
+    get SelectionStrategy(): 'Default' | 'Specific' | 'ByPower' | null;
+    set SelectionStrategy(value: 'Default' | 'Specific' | 'ByPower' | null);
+    /**
+    * * Field Name: CacheHit
+    * * Display Name: Cache Hit
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Indicates whether this result was served from cache rather than executing a new model call
+    */
+    get CacheHit(): boolean;
+    set CacheHit(value: boolean);
+    /**
+    * * Field Name: CacheKey
+    * * Display Name: Cache Key
+    * * SQL Data Type: nvarchar(500)
+    * * Description: Unique key used for caching this prompt result, typically a hash of the prompt and parameters
+    */
+    get CacheKey(): string | null;
+    set CacheKey(value: string | null);
+    /**
+    * * Field Name: JudgeID
+    * * Display Name: Judge ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: AI Prompts (vwAIPrompts.ID)
+    * * Description: ID of the AIPrompt used as a judge to evaluate and rank multiple parallel execution results
+    */
+    get JudgeID(): string | null;
+    set JudgeID(value: string | null);
+    /**
+    * * Field Name: JudgeScore
+    * * Display Name: Judge Score
+    * * SQL Data Type: float(53)
+    * * Description: Score assigned by the judge prompt when evaluating multiple results. Higher scores indicate better results
+    */
+    get JudgeScore(): number | null;
+    set JudgeScore(value: number | null);
+    /**
+    * * Field Name: WasSelectedResult
+    * * Display Name: Was Selected Result
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Indicates whether this result was selected as the best result when multiple models were run in parallel
+    */
+    get WasSelectedResult(): boolean;
+    set WasSelectedResult(value: boolean);
+    /**
+    * * Field Name: StreamingEnabled
+    * * Display Name: Streaming Enabled
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Indicates whether streaming was enabled for this prompt execution
+    */
+    get StreamingEnabled(): boolean;
+    set StreamingEnabled(value: boolean);
+    /**
+    * * Field Name: FirstTokenTime
+    * * Display Name: First Token Time
+    * * SQL Data Type: int
+    * * Description: Time in milliseconds from request initiation to receiving the first token from the model
+    */
+    get FirstTokenTime(): number | null;
+    set FirstTokenTime(value: number | null);
+    /**
+    * * Field Name: ErrorDetails
+    * * Display Name: Error Details
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Detailed error information in JSON format if the prompt execution failed, including stack traces and error codes
+    */
+    get ErrorDetails(): string | null;
+    set ErrorDetails(value: string | null);
+    /**
     * * Field Name: Prompt
     * * Display Name: Prompt
     * * SQL Data Type: nvarchar(255)
@@ -23972,6 +24167,12 @@ export declare class AIPromptRunEntity extends BaseEntity<AIPromptRunEntityType>
     * * SQL Data Type: nvarchar(50)
     */
     get OriginalModel(): string | null;
+    /**
+    * * Field Name: Judge
+    * * Display Name: Judge
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Judge(): string | null;
 }
 /**
  * MJ: AI Vendor Type Definitions - strongly typed entity sub-class
@@ -24399,6 +24600,16 @@ export declare class ConversationArtifactVersionEntity extends BaseEntity<Conver
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * MJ: Conversation Artifact Versions - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof ConversationArtifactVersionEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * Validate() method override for MJ: Conversation Artifact Versions entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * Version: This rule ensures that the version number must be greater than zero.
     * @public
@@ -24508,6 +24719,16 @@ export declare class ConversationArtifactEntity extends BaseEntity<ConversationA
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * MJ: Conversation Artifacts - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof ConversationArtifactEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -25375,6 +25596,16 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * Queries - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof QueryEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -27411,6 +27642,16 @@ export declare class ReportEntity extends BaseEntity<ReportEntityType> {
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * Reports - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof ReportEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier