@memberjunction/core-entities 5.20.0 → 5.22.0

package/dist/generated/entity_subclasses.d.ts

@@ -3322,6 +3322,7 @@ export declare const MJAIPromptSchema: z.ZodObject<{
     EffortLevel: z.ZodNullable<z.ZodNumber>;
     AssistantPrefill: z.ZodNullable<z.ZodString>;
     PrefillFallbackMode: z.ZodUnion<[z.ZodLiteral<"Ignore">, z.ZodLiteral<"None">, z.ZodLiteral<"SystemInstruction">]>;
+    RequireSpecificModels: z.ZodBoolean;
     Template: z.ZodString;
     Category: z.ZodNullable<z.ZodString>;
     Type: z.ZodString;
@@ -3385,6 +3386,7 @@ export declare const MJAIPromptSchema: z.ZodObject<{
     FailoverModelStrategy?: "PreferDifferentModel" | "PreferSameModel" | "RequireSameModel";
     FailoverErrorScope?: "All" | "NetworkOnly" | "RateLimitOnly" | "ServiceErrorOnly";
     PrefillFallbackMode?: "None" | "Ignore" | "SystemInstruction";
+    RequireSpecificModels?: boolean;
     Template?: string;
     ResultSelectorPrompt?: string;
     RootResultSelectorPromptID?: string;
@@ -3445,6 +3447,7 @@ export declare const MJAIPromptSchema: z.ZodObject<{
     FailoverModelStrategy?: "PreferDifferentModel" | "PreferSameModel" | "RequireSameModel";
     FailoverErrorScope?: "All" | "NetworkOnly" | "RateLimitOnly" | "ServiceErrorOnly";
     PrefillFallbackMode?: "None" | "Ignore" | "SystemInstruction";
+    RequireSpecificModels?: boolean;
     Template?: string;
     ResultSelectorPrompt?: string;
     RootResultSelectorPromptID?: string;
@@ -7981,11 +7984,14 @@ export declare const MJEntityDocumentSchema: z.ZodObject<{
     AbsoluteMatchThreshold: z.ZodNumber;
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
+    VectorIndexID: z.ZodNullable<z.ZodString>;
+    Configuration: z.ZodNullable<z.ZodString>;
     Type: z.ZodString;
     Entity: z.ZodString;
     VectorDatabase: z.ZodString;
     Template: z.ZodString;
     AIModel: z.ZodString;
+    VectorIndex: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
     EntityID?: string;
@@ -7995,6 +8001,7 @@ export declare const MJEntityDocumentSchema: z.ZodObject<{
     Name?: string;
     Status?: "Active" | "Inactive";
     Type?: string;
+    Configuration?: string;
     TypeID?: string;
     AIModelID?: string;
     AIModel?: string;
@@ -8003,7 +8010,9 @@ export declare const MJEntityDocumentSchema: z.ZodObject<{
     VectorDatabaseID?: string;
     PotentialMatchThreshold?: number;
     AbsoluteMatchThreshold?: number;
+    VectorIndexID?: string;
     VectorDatabase?: string;
+    VectorIndex?: string;
 }, {
     ID?: string;
     EntityID?: string;
@@ -8013,6 +8022,7 @@ export declare const MJEntityDocumentSchema: z.ZodObject<{
     Name?: string;
     Status?: "Active" | "Inactive";
     Type?: string;
+    Configuration?: string;
     TypeID?: string;
     AIModelID?: string;
     AIModel?: string;
@@ -8021,7 +8031,9 @@ export declare const MJEntityDocumentSchema: z.ZodObject<{
     VectorDatabaseID?: string;
     PotentialMatchThreshold?: number;
     AbsoluteMatchThreshold?: number;
+    VectorIndexID?: string;
     VectorDatabase?: string;
+    VectorIndex?: string;
 }>;
 export type MJEntityDocumentEntityType = z.infer<typeof MJEntityDocumentSchema>;
 /**
@@ -8481,12 +8493,12 @@ export declare const MJEntityRecordDocumentSchema: z.ZodObject<{
     Entity?: string;
     EntityDocumentID?: string;
     EntityDocument?: string;
-    DocumentText?: string;
     VectorIndexID?: string;
+    VectorIndex?: string;
+    DocumentText?: string;
     VectorID?: string;
     VectorJSON?: string;
     EntityRecordUpdatedAt?: Date;
-    VectorIndex?: string;
 }, {
     ID?: string;
     EntityID?: string;
@@ -8496,12 +8508,12 @@ export declare const MJEntityRecordDocumentSchema: z.ZodObject<{
     Entity?: string;
     EntityDocumentID?: string;
     EntityDocument?: string;
-    DocumentText?: string;
     VectorIndexID?: string;
+    VectorIndex?: string;
+    DocumentText?: string;
     VectorID?: string;
     VectorJSON?: string;
     EntityRecordUpdatedAt?: Date;
-    VectorIndex?: string;
 }>;
 export type MJEntityRecordDocumentEntityType = z.infer<typeof MJEntityRecordDocumentSchema>;
 /**
@@ -13923,12 +13935,14 @@ export declare const MJVectorDatabaseSchema: z.ZodObject<{
     ClassKey: z.ZodNullable<z.ZodString>;
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
+    Configuration: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
     __mj_CreatedAt?: Date;
     __mj_UpdatedAt?: Date;
     Name?: string;
     Description?: string;
+    Configuration?: string;
     DefaultURL?: string;
     ClassKey?: string;
 }, {
@@ -13937,6 +13951,7 @@ export declare const MJVectorDatabaseSchema: z.ZodObject<{
     __mj_UpdatedAt?: Date;
     Name?: string;
     Description?: string;
+    Configuration?: string;
     DefaultURL?: string;
     ClassKey?: string;
 }>;
@@ -13952,6 +13967,10 @@ export declare const MJVectorIndexSchema: z.ZodObject<{
     EmbeddingModelID: z.ZodString;
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
+    ExternalID: z.ZodNullable<z.ZodString>;
+    Dimensions: z.ZodNullable<z.ZodNumber>;
+    Metric: z.ZodNullable<z.ZodString>;
+    ProviderConfig: z.ZodNullable<z.ZodString>;
     VectorDatabase: z.ZodString;
     EmbeddingModel: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -13962,8 +13981,12 @@ export declare const MJVectorIndexSchema: z.ZodObject<{
     Description?: string;
     EmbeddingModelID?: string;
     EmbeddingModel?: string;
+    ExternalID?: string;
     VectorDatabaseID?: string;
     VectorDatabase?: string;
+    Dimensions?: number;
+    Metric?: string;
+    ProviderConfig?: string;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -13972,8 +13995,12 @@ export declare const MJVectorIndexSchema: z.ZodObject<{
     Description?: string;
     EmbeddingModelID?: string;
     EmbeddingModel?: string;
+    ExternalID?: string;
     VectorDatabaseID?: string;
     VectorDatabase?: string;
+    Dimensions?: number;
+    Metric?: string;
+    ProviderConfig?: string;
 }>;
 export type MJVectorIndexEntityType = z.infer<typeof MJVectorIndexSchema>;
 /**
@@ -24503,7 +24530,7 @@ export declare class MJAIPromptEntity extends BaseEntity<MJAIPromptEntityType> {
     set CacheMustMatchAgent(value: boolean);
     /**
     * * Field Name: CacheMustMatchConfig
-    * * Display Name: Cache Must Match Configuration
+    * * Display Name: Cache Must Match Config
     * * SQL Data Type: bit
     * * Default Value: 0
     * * Description: When true, the configuration must match for a cache hit. When false, results from any configuration can be used.
@@ -24649,7 +24676,7 @@ export declare class MJAIPromptEntity extends BaseEntity<MJAIPromptEntityType> {
     set FailoverMaxAttempts(value: number | null);
     /**
     * * Field Name: FailoverDelaySeconds
-    * * Display Name: Failover Delay (seconds)
+    * * Display Name: Failover Delay (Seconds)
     * * SQL Data Type: int
     * * Default Value: 5
     * * Description: Initial delay in seconds between failover attempts
@@ -24723,6 +24750,15 @@ export declare class MJAIPromptEntity extends BaseEntity<MJAIPromptEntityType> {
     get PrefillFallbackMode(): 'Ignore' | 'None' | 'SystemInstruction';
     set PrefillFallbackMode(value: 'Ignore' | 'None' | 'SystemInstruction');
     /**
+    * * Field Name: RequireSpecificModels
+    * * Display Name: Require Specific Models
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Only applies when SelectionStrategy is Specific. When 0 (default), if none of the explicitly configured AIPromptModel entries have valid API credentials the system automatically falls back to Default/ByPower model selection across all active models matching the prompt AIModelTypeID. When 1, the system will hard-fail with an error instead of falling back, ensuring only the explicitly configured models are ever used.
+    */
+    get RequireSpecificModels(): boolean;
+    set RequireSpecificModels(value: boolean);
+    /**
     * * Field Name: Template
     * * Display Name: Template Text
     * * SQL Data Type: nvarchar(255)
@@ -37313,7 +37349,7 @@ export declare class MJEntityDocumentEntity extends BaseEntity<MJEntityDocumentE
     set Name(value: string);
     /**
     * * Field Name: TypeID
-    * * Display Name: Type ID
+    * * Display Name: Type
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: MJ: Entity Document Types (vwEntityDocumentTypes.ID)
     */
@@ -37321,7 +37357,7 @@ export declare class MJEntityDocumentEntity extends BaseEntity<MJEntityDocumentE
     set TypeID(value: string);
     /**
     * * Field Name: EntityID
-    * * Display Name: Entity ID
+    * * Display Name: Entity
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: MJ: Entities (vwEntities.ID)
     */
@@ -37329,7 +37365,7 @@ export declare class MJEntityDocumentEntity extends BaseEntity<MJEntityDocumentE
     set EntityID(value: string);
     /**
     * * Field Name: VectorDatabaseID
-    * * Display Name: Vector Database ID
+    * * Display Name: Vector Database
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: MJ: Vector Databases (vwVectorDatabases.ID)
     */
@@ -37349,7 +37385,7 @@ export declare class MJEntityDocumentEntity extends BaseEntity<MJEntityDocumentE
     set Status(value: 'Active' | 'Inactive');
     /**
     * * Field Name: TemplateID
-    * * Display Name: Template ID
+    * * Display Name: Template
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: MJ: Templates (vwTemplates.ID)
     */
@@ -37357,7 +37393,7 @@ export declare class MJEntityDocumentEntity extends BaseEntity<MJEntityDocumentE
     set TemplateID(value: string);
     /**
     * * Field Name: AIModelID
-    * * Display Name: AIModel ID
+    * * Display Name: AI Model
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: MJ: AI Models (vwAIModels.ID)
     */
@@ -37383,48 +37419,71 @@ export declare class MJEntityDocumentEntity extends BaseEntity<MJEntityDocumentE
     set AbsoluteMatchThreshold(value: number);
     /**
     * * Field Name: __mj_CreatedAt
-    * * Display Name: __mj _Created At
+    * * Display Name: Created At
     * * SQL Data Type: datetimeoffset
     * * Default Value: getutcdate()
     */
     get __mj_CreatedAt(): Date;
     /**
     * * Field Name: __mj_UpdatedAt
-    * * Display Name: __mj _Updated At
+    * * Display Name: Updated At
     * * SQL Data Type: datetimeoffset
     * * Default Value: getutcdate()
     */
     get __mj_UpdatedAt(): Date;
     /**
+    * * Field Name: VectorIndexID
+    * * Display Name: Vector Index
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: MJ: Vector Indexes (vwVectorIndexes.ID)
+    * * Description: Optional foreign key to the specific Vector Index where this entity document's embeddings should be stored. When specified, the vectorization pipeline will upsert vectors directly to this index rather than auto-creating or looking up an index based on VectorDatabaseID + AIModelID. This enables explicit control over which Pinecone/Weaviate/etc. index is used per entity document, supporting multi-index architectures and shared indexes across entity types.
+    */
+    get VectorIndexID(): string | null;
+    set VectorIndexID(value: string | null);
+    /**
+    * * Field Name: Configuration
+    * * Display Name: Configuration
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON configuration settings for this entity document. Controls vector metadata field inclusion (which fields get stored in the vector index for search result display), large field truncation limits, and future settings like sync scheduling and threshold overrides. NULL means use system defaults.
+    */
+    get Configuration(): string | null;
+    set Configuration(value: string | null);
+    /**
     * * Field Name: Type
-    * * Display Name: Type
+    * * Display Name: Type Name
     * * SQL Data Type: nvarchar(100)
     */
     get Type(): string;
     /**
     * * Field Name: Entity
-    * * Display Name: Entity
+    * * Display Name: Entity Name
     * * SQL Data Type: nvarchar(255)
     */
     get Entity(): string;
     /**
     * * Field Name: VectorDatabase
-    * * Display Name: Vector Database
+    * * Display Name: Vector Database Name
     * * SQL Data Type: nvarchar(100)
     */
     get VectorDatabase(): string;
     /**
     * * Field Name: Template
-    * * Display Name: Template
+    * * Display Name: Template Name
     * * SQL Data Type: nvarchar(255)
     */
     get Template(): string;
     /**
     * * Field Name: AIModel
-    * * Display Name: AIModel
+    * * Display Name: AI Model Name
     * * SQL Data Type: nvarchar(50)
     */
     get AIModel(): string;
+    /**
+    * * Field Name: VectorIndex
+    * * Display Name: Vector Index Name
+    * * SQL Data Type: nvarchar(255)
+    */
+    get VectorIndex(): string | null;
 }
 /**
  * MJ: Entity Field Values - strongly typed entity sub-class
@@ -53633,6 +53692,14 @@ export declare class MJVectorDatabaseEntity extends BaseEntity<MJVectorDatabaseE
     * * Default Value: getutcdate()
     */
     get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: Configuration
+    * * Display Name: Configuration
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON configuration settings for this vector database provider. Stores provider-specific connection settings like custom host URLs, authentication configuration, timeouts, retry policies, and batch size limits. NULL means use defaults from environment variables or provider defaults.
+    */
+    get Configuration(): string | null;
+    set Configuration(value: string | null);
 }
 /**
  * MJ: Vector Indexes - strongly typed entity sub-class
@@ -53682,7 +53749,7 @@ export declare class MJVectorIndexEntity extends BaseEntity<MJVectorIndexEntityT
     set Description(value: string | null);
     /**
     * * Field Name: VectorDatabaseID
-    * * Display Name: Vector Database ID
+    * * Display Name: Vector Database
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: MJ: Vector Databases (vwVectorDatabases.ID)
     */
@@ -53690,7 +53757,7 @@ export declare class MJVectorIndexEntity extends BaseEntity<MJVectorIndexEntityT
     set VectorDatabaseID(value: string);
     /**
     * * Field Name: EmbeddingModelID
-    * * Display Name: Embedding Model ID
+    * * Display Name: Embedding Model
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: MJ: AI Models (vwAIModels.ID)
     */
@@ -53711,14 +53778,46 @@ export declare class MJVectorIndexEntity extends BaseEntity<MJVectorIndexEntityT
     */
     get __mj_UpdatedAt(): Date;
     /**
+    * * Field Name: ExternalID
+    * * Display Name: External ID
+    * * SQL Data Type: nvarchar(500)
+    * * Description: The provider's native identifier for this index. For Pinecone this is the index name; for other providers it may be a separate UUID or identifier. Used for syncing operations between MJ metadata and the remote vector database.
+    */
+    get ExternalID(): string | null;
+    set ExternalID(value: string | null);
+    /**
+    * * Field Name: Dimensions
+    * * Display Name: Dimensions
+    * * SQL Data Type: int
+    * * Description: The number of dimensions for vectors stored in this index. Determined by the embedding model (e.g., 1536 for text-embedding-3-small, 768 for all-mpnet-base-v2). Set automatically when the index is created via the vector database provider.
+    */
+    get Dimensions(): number | null;
+    set Dimensions(value: number | null);
+    /**
+    * * Field Name: Metric
+    * * Display Name: Distance Metric
+    * * SQL Data Type: nvarchar(50)
+    * * Description: The distance metric used for similarity calculations in this index. Common values: cosine (default, measures angular similarity), euclidean (L2 distance), dotproduct (inner product). Must match what the vector database provider was configured with.
+    */
+    get Metric(): string | null;
+    set Metric(value: string | null);
+    /**
+    * * Field Name: ProviderConfig
+    * * Display Name: Provider Configuration
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON object containing provider-specific configuration for this index. For Pinecone serverless: {"cloud":"aws","region":"us-east-1"}. For pod-based: {"environment":"us-east1-gcp","podType":"p1.x1","replicas":1}. Stored as a flexible JSON bag to support any provider without schema changes.
+    */
+    get ProviderConfig(): string | null;
+    set ProviderConfig(value: string | null);
+    /**
     * * Field Name: VectorDatabase
-    * * Display Name: Vector Database
+    * * Display Name: Vector Database Name
     * * SQL Data Type: nvarchar(100)
     */
     get VectorDatabase(): string;
     /**
     * * Field Name: EmbeddingModel
-    * * Display Name: Embedding Model
+    * * Display Name: Embedding Model Name
     * * SQL Data Type: nvarchar(50)
     */
     get EmbeddingModel(): string;