@memberjunction/ai 2.50.0 → 2.51.0

package/dist/generic/prompt.types.d.ts

@@ -0,0 +1,62 @@
+import { ChatResult } from './chat.types';
+export type ExecutionStatus = 'pending' | 'running' | 'completed' | 'failed' | 'cancelled';
+export type CancellationReason = 'user_requested' | 'timeout' | 'error' | 'resource_limit';
+export interface ModelInfo {
+    modelId: string;
+    modelName: string;
+    vendorId?: string;
+    vendorName?: string;
+    powerRank?: number;
+    modelType?: string;
+}
+export interface JudgeMetadata {
+    judgePromptId: string;
+    judgeExecutionTimeMS: number;
+    judgeTokensUsed?: number;
+    judgeCancelled?: boolean;
+    judgeErrorMessage?: string;
+}
+export interface ValidationAttempt {
+    attemptNumber: number;
+    success: boolean;
+    errorMessage?: string;
+    validationErrors?: any[];
+    rawOutput: string;
+    parsedOutput?: unknown;
+    timestamp: Date;
+}
+export interface AIPromptRunResult<T = unknown> {
+    success: boolean;
+    status?: ExecutionStatus;
+    cancelled?: boolean;
+    cancellationReason?: CancellationReason;
+    rawResult?: string;
+    result?: T;
+    chatResult: ChatResult;
+    errorMessage?: string;
+    promptRun?: any;
+    executionTimeMS?: number;
+    promptTokens?: number;
+    completionTokens?: number;
+    tokensUsed?: number;
+    combinedPromptTokens?: number;
+    combinedCompletionTokens?: number;
+    combinedTokensUsed?: number;
+    cost?: number;
+    costCurrency?: string;
+    combinedCost?: number;
+    validationResult?: any;
+    validationAttempts?: ValidationAttempt[];
+    additionalResults?: AIPromptRunResult<T>[];
+    ranking?: number;
+    judgeRationale?: string;
+    modelInfo?: ModelInfo;
+    judgeMetadata?: JudgeMetadata;
+    wasStreamed?: boolean;
+    cacheInfo?: {
+        cacheHit: boolean;
+        cacheKey?: string;
+        cacheSource?: string;
+    };
+}
+//# sourceMappingURL=prompt.types.d.ts.map

package/dist/generic/prompt.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.types.d.ts","sourceRoot":"","sources":["../../src/generic/prompt.types.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAK1C,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;AAK3F,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,SAAS,GAAG,OAAO,GAAG,gBAAgB,CAAC;AAK3F,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAKD,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAKD,MAAM,WAAW,iBAAiB;IAEhC,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,OAAO,CAAC;IAEjB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,gBAAgB,CAAC,EAAE,GAAG,EAAE,CAAC;IAEzB,SAAS,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,SAAS,EAAE,IAAI,CAAC;CACjB;AAKD,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,OAAO;IAI5C,OAAO,EAAE,OAAO,CAAC;IAKjB,MAAM,CAAC,EAAE,eAAe,CAAC;IAKzB,SAAS,CAAC,EAAE,OAAO,CAAC;IAKpB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAKxC,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,MAAM,CAAC,EAAE,CAAC,CAAC;IAMX,UAAU,EAAE,UAAU,CAAC;IAKvB,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,GAAG,CAAC;IAKhB,eAAe,CAAC,EAAE,MAAM,CAAC;IAMzB,YAAY,CAAC,EAAE,MAAM,CAAC;IAMtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAO1B,UAAU,CAAC,EAAE,MAAM,CAAC;IAMpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAM9B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAOlC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAM5B,IAAI,CAAC,EAAE,MAAM,CAAC;IAMd,YAAY,CAAC,EAAE,MAAM,CAAC;IAOtB,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,gBAAgB,CAAC,EAAE,GAAG,CAAC;IAKvB,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAOzC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;IAK3C,OAAO,CAAC,EAAE,MAAM,CAAC;IAKjB,cAAc,CAAC,EAAE,MAAM,CAAC;IAKxB,SAAS,CAAC,EAAE,SAAS,CAAC;IAKtB,aAAa,CAAC,EAAE,aAAa,CAAC;IAK9B,WAAW,CAAC,EAAE,OAAO,CAAC;IAKtB,SAAS,CAAC,EAAE;QACV,QAAQ,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH"}

package/dist/generic/prompt.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=prompt.types.js.map

package/dist/generic/prompt.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.types.js","sourceRoot":"","sources":["../../src/generic/prompt.types.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -9,4 +9,5 @@ export * from './generic/embed.types';
 export * from './generic/baseEmbeddings';
 export * from './generic/baseAudio';
 export * from './generic/baseVideo';
+export * from './generic/prompt.types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC"}

package/dist/index.js

@@ -25,4 +25,5 @@ __exportStar(require("./generic/embed.types"), exports);
 __exportStar(require("./generic/baseEmbeddings"), exports);
 __exportStar(require("./generic/baseAudio"), exports);
 __exportStar(require("./generic/baseVideo"), exports);
+__exportStar(require("./generic/prompt.types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAmC;AACnC,oDAAkC;AAClC,0DAAwC;AACxC,uDAAqC;AACrC,2DAAyC;AACzC,4DAA0C;AAC1C,6DAA2C;AAC3C,wDAAsC;AACtC,2DAAyC;AACzC,sDAAoC;AACpC,sDAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAmC;AACnC,oDAAkC;AAClC,0DAAwC;AACxC,uDAAqC;AACrC,2DAAyC;AACzC,4DAA0C;AAC1C,6DAA2C;AAC3C,wDAAsC;AACtC,2DAAyC;AACzC,sDAAoC;AACpC,sDAAoC;AACpC,yDAAuC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/ai",
-  "version": "2.50.0",
+  "version": "2.51.0",
   "description": "MemberJunction: AI Module - LLMs and other AI services wrapped and abstracted for use in MemberJunction",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,7 @@
   "author": "MemberJunction.com",
   "license": "ISC",
   "dependencies": {
-    "@memberjunction/global": "2.50.0",
+    "@memberjunction/global": "2.51.0",
     "dotenv": "^16.4.1",
     "rxjs": "^7.8.1"
   },

package/readme.md

@@ -6,6 +6,17 @@ The MemberJunction AI Core package provides a comprehensive abstraction layer fo
 
 This package serves as the foundation for all AI capabilities in the MemberJunction ecosystem. It defines abstract base classes and interfaces that are implemented by provider-specific packages, enabling seamless integration with various AI services while maintaining a consistent API.
 
+### Type Organization Update (2025)
+
+As part of a major type reorganization to improve code organization and reduce circular dependencies:
+- **Core Package** now contains:
+  - Base AI model abstractions (`BaseModel`, `BaseLLM`, `BaseEmbeddings`, etc.)
+  - Core AI result types (`BaseResult`, `ChatResult`, `ModelUsage`, etc.)
+  - Common interfaces and types used across all AI packages
+- **Agent-specific types** have moved to `@memberjunction/ai-agents`
+- **Prompt-specific types** remain in `@memberjunction/ai-prompts`
+- **Engine-specific types** (like agent type definitions) are in `@memberjunction/aiengine`
+
 ## Standalone Usage
 
 **IMPORTANT**: This package can be used completely independently from the rest of the MemberJunction framework:
@@ -538,11 +549,53 @@ The BaseLLM class uses a template method pattern for handling streaming:
 
 This architecture allows for a clean separation between common streaming logic and provider-specific implementations.
 
+## Import Examples
+
+```typescript
+// Import base model classes
+import { BaseLLM, BaseEmbeddings, BaseAudioGenerator } from '@memberjunction/ai';
+
+// Import result types
+import { ChatResult, ModelUsage, BaseResult } from '@memberjunction/ai';
+
+// Import parameter types
+import { ChatParams, ChatMessage, StreamingChatCallbacks } from '@memberjunction/ai';
+
+// Import utility classes
+import { AIAPIKeys, GetAIAPIKey } from '@memberjunction/ai';
+```
+
 ## Dependencies
 
 - `@memberjunction/global` - MemberJunction global utilities including class factory
 - `rxjs` - Reactive extensions for JavaScript
 
+## Type Exports
+
+The Core package exports fundamental types used throughout the AI ecosystem:
+
+### Base Model Classes
+- `BaseModel` - Foundation class for all AI models
+- `BaseLLM` - Base class for language models
+- `BaseEmbeddings` - Base class for embedding models
+- `BaseAudioGenerator` - Base class for audio models
+- `BaseVideoGenerator` - Base class for video models
+- `BaseDiffusion` - Base class for image generation models
+
+### Core Result Types
+- `BaseResult` - Base result structure for all AI operations
+- `ChatResult` - Result from chat completions
+- `ModelUsage` - Token/resource usage tracking
+- `SummarizeResult` - Text summarization results
+- `ClassifyResult` - Text classification results
+- `EmbeddingResult` - Embedding generation results
+
+### Common Interfaces
+- `ChatMessage` - Message structure for conversations
+- `ChatParams` - Parameters for chat operations
+- `StreamingChatCallbacks` - Callbacks for streaming responses
+- `ParallelChatCompletionsCallbacks` - Callbacks for parallel execution
+
 ## API Reference
 
 ### Result Types