@memberjunction/core-entities 2.63.1 → 2.65.0

package/dist/generated/entity_subclasses.js

@@ -470,7 +470,8 @@ exports.ActionSchema = zod_1.z.object({
     Name: zod_1.z.string().describe(`
         * * Field Name: Name
         * * Display Name: Name
-        * * SQL Data Type: nvarchar(425)`),
+        * * SQL Data Type: nvarchar(425)
+    * * Description: The name of the action. Must be unique within the combination of CategoryID and ParentID. Actions with the same name can exist in different categories or under different parents.`),
     Description: zod_1.z.string().nullable().describe(`
         * * Field Name: Description
         * * Display Name: Description
@@ -999,7 +1000,8 @@ exports.AIAgentSchema = zod_1.z.object({
     LogoURL: zod_1.z.string().nullable().describe(`
         * * Field Name: LogoURL
         * * Display Name: Logo URL
-        * * SQL Data Type: nvarchar(255)`),
+        * * SQL Data Type: nvarchar(255)
+    * * Description: URL to an image file or base64 data URI (e.g., data:image/png;base64,...) for the agent logo. Takes precedence over IconClass in UI display.`),
     __mj_CreatedAt: zod_1.z.date().describe(`
         * * Field Name: __mj_CreatedAt
         * * Display Name: Created At
@@ -1102,6 +1104,18 @@ exports.AIAgentSchema = zod_1.z.object({
         * * SQL Data Type: nvarchar(MAX)
         * * Default Value: ["*"]
     * * Description: JSON array of paths that define which parts of the payload sub-agents are allowed to write back upstream. Use ["*"] to allow all writes, or specify paths like ["analysis.results", "recommendations.*"]`),
+    PayloadSelfReadPaths: zod_1.z.string().nullable().describe(`
+        * * Field Name: PayloadSelfReadPaths
+        * * Display Name: Payload Self Read Paths
+        * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON array of paths that specify what parts of the payload the agent's own prompt can read. Controls downstream data 
+flow when the agent executes its own prompt step.`),
+    PayloadSelfWritePaths: zod_1.z.string().nullable().describe(`
+        * * Field Name: PayloadSelfWritePaths
+        * * Display Name: Payload Self Write Paths
+        * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON array of paths that specify what parts of the payload the agent's own prompt can write back. Controls upstream 
+data flow when the agent executes its own prompt step.`),
     Parent: zod_1.z.string().nullable().describe(`
         * * Field Name: Parent
         * * Display Name: Parent
@@ -11457,7 +11471,8 @@ exports.UserSchema = zod_1.z.object({
         * * SQL Data Type: nvarchar(50)`),
     Email: zod_1.z.string().describe(`
         * * Field Name: Email
-        * * SQL Data Type: nvarchar(100)`),
+        * * SQL Data Type: nvarchar(100)
+    * * Description: Unique email address for the user. This field must be unique across all users in the system.`),
     Type: zod_1.z.union([zod_1.z.literal('User'), zod_1.z.literal('Owner')]).describe(`
         * * Field Name: Type
         * * SQL Data Type: nchar(15)
@@ -13122,6 +13137,7 @@ let ActionEntity = class ActionEntity extends core_1.BaseEntity {
     * * Field Name: Name
     * * Display Name: Name
     * * SQL Data Type: nvarchar(425)
+    * * Description: The name of the action. Must be unique within the combination of CategoryID and ParentID. Actions with the same name can exist in different categories or under different parents.
     */
     get Name() {
         return this.Get('Name');
@@ -14157,6 +14173,7 @@ exports.AIAgentNoteEntity = AIAgentNoteEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIAgentRequest
  * * Base View: vwAIAgentRequests
+ * * @description Table to log AI Agent requests, responses, and their statuses.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -14469,6 +14486,7 @@ let AIAgentEntity = class AIAgentEntity extends core_1.BaseEntity {
     * * Field Name: LogoURL
     * * Display Name: Logo URL
     * * SQL Data Type: nvarchar(255)
+    * * Description: URL to an image file or base64 data URI (e.g., data:image/png;base64,...) for the agent logo. Takes precedence over IconClass in UI display.
     */
     get LogoURL() {
         return this.Get('LogoURL');
@@ -14692,6 +14710,32 @@ let AIAgentEntity = class AIAgentEntity extends core_1.BaseEntity {
         this.Set('PayloadUpstreamPaths', value);
     }
     /**
+    * * Field Name: PayloadSelfReadPaths
+    * * Display Name: Payload Self Read Paths
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON array of paths that specify what parts of the payload the agent's own prompt can read. Controls downstream data
+flow when the agent executes its own prompt step.
+    */
+    get PayloadSelfReadPaths() {
+        return this.Get('PayloadSelfReadPaths');
+    }
+    set PayloadSelfReadPaths(value) {
+        this.Set('PayloadSelfReadPaths', value);
+    }
+    /**
+    * * Field Name: PayloadSelfWritePaths
+    * * Display Name: Payload Self Write Paths
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON array of paths that specify what parts of the payload the agent's own prompt can write back. Controls upstream
+data flow when the agent executes its own prompt step.
+    */
+    get PayloadSelfWritePaths() {
+        return this.Get('PayloadSelfWritePaths');
+    }
+    set PayloadSelfWritePaths(value) {
+        this.Set('PayloadSelfWritePaths', value);
+    }
+    /**
     * * Field Name: Parent
     * * Display Name: Parent
     * * SQL Data Type: nvarchar(255)
@@ -28196,6 +28240,7 @@ exports.FileEntity = FileEntity = __decorate([
  * * Schema: __mj
  * * Base Table: GeneratedCodeCategory
  * * Base View: vwGeneratedCodeCategories
+ * * @description Categorization for generated code, including optional parent-child relationships.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -28301,6 +28346,7 @@ exports.GeneratedCodeCategoryEntity = GeneratedCodeCategoryEntity = __decorate([
  * * Schema: __mj
  * * Base Table: GeneratedCode
  * * Base View: vwGeneratedCodes
+ * * @description Stores LLM-generated code snippets, tracking their source, category, and validation status.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -29484,6 +29530,7 @@ exports.ListEntity = ListEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIAgentPrompt
  * * Base View: vwAIAgentPrompts
+ * * @description Links AI agents with the prompts they use, including execution order and context handling.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -29709,6 +29756,7 @@ exports.AIAgentPromptEntity = AIAgentPromptEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIAgentRunStep
  * * Base View: vwAIAgentRunSteps
+ * * @description Provides basic, step-by-step tracking of agent execution. Each step represents a discrete action within an agent run, such as prompt execution, tool usage, decision making, or sub-agent coordination.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -29993,6 +30041,7 @@ exports.AIAgentRunStepEntity = AIAgentRunStepEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIAgentRun
  * * Base View: vwAIAgentRuns
+ * * @description Tracks individual execution runs of AI agents, including hierarchical sub-agent runs. Provides basic logging, state persistence, and resource tracking for agent executions. Supports pause/resume functionality through state serialization.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -30435,6 +30484,7 @@ exports.AIAgentRunEntity = AIAgentRunEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIAgentType
  * * Base View: vwAIAgentTypes
+ * * @description Defines types of AI agents with their system prompts and behavioral characteristics. Each agent type represents a category of agents that share common system-level instructions and capabilities.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -30580,6 +30630,7 @@ exports.AIAgentTypeEntity = AIAgentTypeEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIConfigurationParam
  * * Base View: vwAIConfigurationParams
+ * * @description Stores configuration parameters that can be referenced by prompts and used to control execution behavior.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -30718,6 +30769,7 @@ exports.AIConfigurationParamEntity = AIConfigurationParamEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIConfiguration
  * * Base View: vwAIConfigurations
+ * * @description Stores configurations for AI prompt execution environments and settings.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -30878,6 +30930,7 @@ exports.AIConfigurationEntity = AIConfigurationEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIModelCost
  * * Base View: vwAIModelCosts
+ * * @description Stores historical and current pricing information for AI models across different vendors, with optional temporal tracking and support for different processing types
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -31191,6 +31244,7 @@ exports.AIModelCostEntity = AIModelCostEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIModelPriceType
  * * Base View: vwAIModelPriceTypes
+ * * @description Defines the different types of pricing metrics used by AI model vendors (e.g., Tokens, Minutes, Characters, API Calls)
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -31300,6 +31354,7 @@ exports.AIModelPriceTypeEntity = AIModelPriceTypeEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIModelPriceUnitType
  * * Base View: vwAIModelPriceUnitTypes
+ * * @description Defines the unit scales used for pricing (e.g., Per 1M Tokens, Per 1K Tokens, Per Minute). Includes driver class for normalization calculations
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -31434,6 +31489,7 @@ exports.AIModelPriceUnitTypeEntity = AIModelPriceUnitTypeEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIModelVendor
  * * Base View: vwAIModelVendors
+ * * @description Associates AI models with vendors providing them, including vendor-specific implementation details.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -31737,6 +31793,7 @@ exports.AIModelVendorEntity = AIModelVendorEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIPromptModel
  * * Base View: vwAIPromptModels
+ * * @description Associates AI prompts with specific models and configurations, including execution details.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -32050,6 +32107,7 @@ exports.AIPromptModelEntity = AIPromptModelEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIPromptRun
  * * Base View: vwAIPromptRuns
+ * * @description Tracks AI prompt executions including timings, inputs, outputs, and performance metrics.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -32900,6 +32958,7 @@ exports.AIPromptRunEntity = AIPromptRunEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIVendorTypeDefinition
  * * Base View: vwAIVendorTypeDefinitions
+ * * @description Defines the possible types of AI vendors, such as Model Developer or Inference Provider.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -32985,6 +33044,7 @@ exports.AIVendorTypeDefinitionEntity = AIVendorTypeDefinitionEntity = __decorate
  * * Schema: __mj
  * * Base Table: AIVendorType
  * * Base View: vwAIVendorTypes
+ * * @description Associates vendors with their types (Model Developer, Inference Provider) and tracks the status of each role.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -33142,6 +33202,7 @@ exports.AIVendorTypeEntity = AIVendorTypeEntity = __decorate([
  * * Schema: __mj
  * * Base Table: AIVendor
  * * Base View: vwAIVendors
+ * * @description Stores information about AI vendors providing models and/or inference services.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -33228,6 +33289,7 @@ exports.AIVendorEntity = AIVendorEntity = __decorate([
  * * Schema: __mj
  * * Base Table: ArtifactType
  * * Base View: vwArtifactTypes
+ * * @description Defines the types of artifacts that can be created within conversations
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -33338,6 +33400,7 @@ exports.ArtifactTypeEntity = ArtifactTypeEntity = __decorate([
  * * Schema: __mj
  * * Base Table: ConversationArtifactPermission
  * * Base View: vwConversationArtifactPermissions
+ * * @description Manages user permissions for conversation artifacts
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -33450,6 +33513,7 @@ exports.ConversationArtifactPermissionEntity = ConversationArtifactPermissionEnt
  * * Schema: __mj
  * * Base Table: ConversationArtifactVersion
  * * Base View: vwConversationArtifactVersions
+ * * @description Stores versions of conversation artifacts
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -33604,6 +33668,7 @@ exports.ConversationArtifactVersionEntity = ConversationArtifactVersionEntity =
  * * Schema: __mj
  * * Base Table: ConversationArtifact
  * * Base View: vwConversationArtifacts
+ * * @description Stores metadata for artifacts created within conversations
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -33762,6 +33827,7 @@ exports.ConversationArtifactEntity = ConversationArtifactEntity = __decorate([
  * * Schema: __mj
  * * Base Table: DashboardUserPreference
  * * Base View: vwDashboardUserPreferences
+ * * @description Stores dashboard preferences for users and system defaults. The absence of a record for a dashboard means it is not shown.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -33941,6 +34007,7 @@ exports.DashboardUserPreferenceEntity = DashboardUserPreferenceEntity = __decora
  * * Schema: __mj
  * * Base Table: DashboardUserState
  * * Base View: vwDashboardUserStates
+ * * @description Stores user-specific dashboard state information
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -34057,6 +34124,7 @@ exports.DashboardUserStateEntity = DashboardUserStateEntity = __decorate([
  * * Schema: __mj
  * * Base Table: ReportUserState
  * * Base View: vwReportUserStates
+ * * @description Tracks individual user state within interactive reports
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -34171,6 +34239,7 @@ exports.ReportUserStateEntity = ReportUserStateEntity = __decorate([
  * * Schema: __mj
  * * Base Table: ReportVersion
  * * Base View: vwReportVersions
+ * * @description Stores iterations of report logic, structure, and layout changes
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -41592,6 +41661,7 @@ let UserEntity = class UserEntity extends core_1.BaseEntity {
     /**
     * * Field Name: Email
     * * SQL Data Type: nvarchar(100)
+    * * Description: Unique email address for the user. This field must be unique across all users in the system.
     */
     get Email() {
         return this.Get('Email');