@memberjunction/core-entities 2.63.1 → 2.65.0

package/dist/generated/entity_subclasses.d.ts

@@ -666,6 +666,8 @@ export declare const AIAgentSchema: z.ZodObject<{
     ModelSelectionMode: z.ZodUnion<[z.ZodLiteral<"Agent Type">, z.ZodLiteral<"Agent">]>;
     PayloadDownstreamPaths: z.ZodString;
     PayloadUpstreamPaths: z.ZodString;
+    PayloadSelfReadPaths: z.ZodNullable<z.ZodString>;
+    PayloadSelfWritePaths: z.ZodNullable<z.ZodString>;
     Parent: z.ZodNullable<z.ZodString>;
     ContextCompressionPrompt: z.ZodNullable<z.ZodString>;
     Type: z.ZodNullable<z.ZodString>;
@@ -693,6 +695,8 @@ export declare const AIAgentSchema: z.ZodObject<{
     ModelSelectionMode?: "Agent" | "Agent Type";
     PayloadDownstreamPaths?: string;
     PayloadUpstreamPaths?: string;
+    PayloadSelfReadPaths?: string;
+    PayloadSelfWritePaths?: string;
     ContextCompressionPrompt?: string;
 }, {
     ID?: string;
@@ -718,6 +722,8 @@ export declare const AIAgentSchema: z.ZodObject<{
     ModelSelectionMode?: "Agent" | "Agent Type";
     PayloadDownstreamPaths?: string;
     PayloadUpstreamPaths?: string;
+    PayloadSelfReadPaths?: string;
+    PayloadSelfWritePaths?: string;
     ContextCompressionPrompt?: string;
 }>;
 export type AIAgentEntityType = z.infer<typeof AIAgentSchema>;
@@ -8874,6 +8880,7 @@ export declare class ActionEntity extends BaseEntity<ActionEntityType> {
     * * 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(): string;
     set Name(value: string);
@@ -9613,6 +9620,7 @@ export declare class AIAgentNoteEntity extends BaseEntity<AIAgentNoteEntityType>
  * * 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
@@ -9830,6 +9838,7 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
     * * 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(): string | null;
     set LogoURL(value: string | null);
@@ -9985,6 +9994,24 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
     get PayloadUpstreamPaths(): string;
     set PayloadUpstreamPaths(value: string);
     /**
+    * * 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(): string | null;
+    set PayloadSelfReadPaths(value: string | null);
+    /**
+    * * 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(): string | null;
+    set PayloadSelfWritePaths(value: string | null);
+    /**
     * * Field Name: Parent
     * * Display Name: Parent
     * * SQL Data Type: nvarchar(255)
@@ -19525,6 +19552,7 @@ export declare class FileEntity extends BaseEntity<FileEntityType> {
  * * Schema: __mj
  * * Base Table: GeneratedCodeCategory
  * * Base View: vwGeneratedCodeCategories
+ * * @description Categorization for generated code, including optional parent-child relationships.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -19600,6 +19628,7 @@ export declare class GeneratedCodeCategoryEntity extends BaseEntity<GeneratedCod
  * * 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
@@ -20443,6 +20472,7 @@ export declare class ListEntity extends BaseEntity<ListEntityType> {
  * * 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
@@ -20606,6 +20636,7 @@ export declare class AIAgentPromptEntity extends BaseEntity<AIAgentPromptEntityT
  * * 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
@@ -20806,6 +20837,7 @@ export declare class AIAgentRunStepEntity extends BaseEntity<AIAgentRunStepEntit
  * * 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
@@ -21118,6 +21150,7 @@ export declare class AIAgentRunEntity extends BaseEntity<AIAgentRunEntityType> {
  * * 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
@@ -21221,6 +21254,7 @@ export declare class AIAgentTypeEntity extends BaseEntity<AIAgentTypeEntityType>
  * * 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
@@ -21321,6 +21355,7 @@ export declare class AIConfigurationParamEntity extends BaseEntity<AIConfigurati
  * * Schema: __mj
  * * Base Table: AIConfiguration
  * * Base View: vwAIConfigurations
+ * * @description Stores configurations for AI prompt execution environments and settings.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -21437,6 +21472,7 @@ export declare class AIConfigurationEntity extends BaseEntity<AIConfigurationEnt
  * * 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
@@ -21653,6 +21689,7 @@ export declare class AIModelCostEntity extends BaseEntity<AIModelCostEntityType>
  * * 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
@@ -21730,6 +21767,7 @@ export declare class AIModelPriceTypeEntity extends BaseEntity<AIModelPriceTypeE
  * * 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
@@ -21823,6 +21861,7 @@ export declare class AIModelPriceUnitTypeEntity extends BaseEntity<AIModelPriceU
  * * 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
@@ -22034,6 +22073,7 @@ export declare class AIModelVendorEntity extends BaseEntity<AIModelVendorEntityT
  * * 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
@@ -22251,6 +22291,7 @@ export declare class AIPromptModelEntity extends BaseEntity<AIPromptModelEntityT
  * * 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
@@ -22830,6 +22871,7 @@ export declare class AIPromptRunEntity extends BaseEntity<AIPromptRunEntityType>
  * * 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
@@ -22891,6 +22933,7 @@ export declare class AIVendorTypeDefinitionEntity extends BaseEntity<AIVendorTyp
  * * 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
@@ -23004,6 +23047,7 @@ export declare class AIVendorTypeEntity extends BaseEntity<AIVendorTypeEntityTyp
  * * 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
@@ -23066,6 +23110,7 @@ export declare class AIVendorEntity extends BaseEntity<AIVendorEntityType> {
  * * 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
@@ -23144,6 +23189,7 @@ export declare class ArtifactTypeEntity extends BaseEntity<ArtifactTypeEntityTyp
  * * Schema: __mj
  * * Base Table: ConversationArtifactPermission
  * * Base View: vwConversationArtifactPermissions
+ * * @description Manages user permissions for conversation artifacts
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -23226,6 +23272,7 @@ export declare class ConversationArtifactPermissionEntity extends BaseEntity<Con
  * * Schema: __mj
  * * Base Table: ConversationArtifactVersion
  * * Base View: vwConversationArtifactVersions
+ * * @description Stores versions of conversation artifacts
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -23334,6 +23381,7 @@ export declare class ConversationArtifactVersionEntity extends BaseEntity<Conver
  * * Schema: __mj
  * * Base Table: ConversationArtifact
  * * Base View: vwConversationArtifacts
+ * * @description Stores metadata for artifacts created within conversations
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -23448,6 +23496,7 @@ export declare class ConversationArtifactEntity extends BaseEntity<ConversationA
  * * 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
@@ -23574,6 +23623,7 @@ export declare class DashboardUserPreferenceEntity extends BaseEntity<DashboardU
  * * Schema: __mj
  * * Base Table: DashboardUserState
  * * Base View: vwDashboardUserStates
+ * * @description Stores user-specific dashboard state information
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -23658,6 +23708,7 @@ export declare class DashboardUserStateEntity extends BaseEntity<DashboardUserSt
  * * Schema: __mj
  * * Base Table: ReportUserState
  * * Base View: vwReportUserStates
+ * * @description Tracks individual user state within interactive reports
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -23740,6 +23791,7 @@ export declare class ReportUserStateEntity extends BaseEntity<ReportUserStateEnt
  * * Schema: __mj
  * * Base Table: ReportVersion
  * * Base View: vwReportVersions
+ * * @description Stores iterations of report logic, structure, and layout changes
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -28980,6 +29032,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
     /**
     * * 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(): string;
     set Email(value: string);