ben-ai-models-registry 1.0.2 → 1.0.4

package/README.md

@@ -1 +1,37 @@
-This repositry is for shared mongoose models used in all Bennie and the AI Jets node apps.
+# Bennie and the AI Jets Shared Mongoose Models
+
+This repository contains shared Mongoose models used across all Bennie and the AI Jets Node.js applications.
+
+## Contents
+
+- **Models**:
+  - `Run`
+  - `JobStatus`
+
+## Usage in Other Applications
+
+To use these models in your application, follow these steps:
+
+1. Install the package:
+   ```sh
+   npm install ben-ai-models-registry
+2. Import the models:
+   ```sh
+   import { Run, JobStatus } from 'ben-ai-models-registry';
+
+## Usage in Other Applications
+
+If you need to make changes to the models, follow these steps:
+1. Clone the repository
+2. Make your changes.
+3. Update the version number in package.json to the next version.
+4. Login to npm:
+   ```sh
+   npm login
+5. Publish the updated package to npm:
+   ```sh
+   npm publish
+   
+Note: You must have publishing access to the npm package to publish changes.
+
+Feel free to contribute to the repository by submitting pull requests with your improvements and suggestions.

package/index.js

@@ -1,8 +1,8 @@
-// index.js
-const JobStatus = require('./models/JobStatus');
-const Run = require('./models/Run');
-
-module.exports = {
-  JobStatus,
-  Run
-};
+// index.js
+const JobStatus = require('./models/JobStatus');
+const Run = require('./models/Run');
+
+module.exports = {
+  JobStatus,
+  Run
+};

package/models/JobStatus.js

@@ -1,19 +1,20 @@
-const mongoose = require('mongoose');
-
-const JobStatusSchema = new mongoose.Schema(
-  {
-    runId: { type: mongoose.Schema.Types.ObjectId, ref: 'Run' },
-    status: {
-      type: String,
-      enum: ['pending', 'in_progress', 'completed', 'failed'],
-      default: 'pending',
-    },
-    progress: {
-      processedQAPairs: { type: Number, default: 0 },
-      totalQAPairs: Number,
-    },
-  },
-  { timestamps: true, versionKey: false }
-);
-
-module.exports = mongoose.model('JobStatus', JobStatusSchema);
+const mongoose = require('mongoose');
+
+const JobStatusSchema = new mongoose.Schema(
+  {
+    runId: { type: mongoose.Schema.Types.ObjectId, ref: 'Run' },
+    status: {
+      type: String,
+      enum: ['pending', 'in_progress', 'completed', 'failed'],
+      default: 'pending',
+    },
+    progress: {
+      processedQAPairs: { type: Number, default: 0 },
+      totalQAPairs: Number,
+    },
+  },
+  { timestamps: true, versionKey: false }
+);
+
+
+module.exports = mongoose.models.JobStatus || mongoose.model('JobStatus', JobStatusSchema);

package/models/Run.js

@@ -1,74 +1,74 @@
-const mongoose = require('mongoose');
-const { Schema } = mongoose;
-
-const AssistantModel = {
-  Langchain: 'langchain-assistant',
-  OpenAI: 'openAI-assistant',
-};
-
-const ModelName = {
-  GPT4O: 'gpt-4o',
-  GPT4TurboPreview: 'gpt-4-turbo-preview',
-  GPT4Turbo: 'gpt-4-turbo',
-  GPT4Turbo20240409: 'gpt-4-turbo-2024-04-09',
-  GPT40125Preview: 'gpt-4-0125-preview',
-  GPT41106Preview: 'gpt-4-1106-preview',
-  GPT4: 'gpt-4',
-  GPT40613: 'gpt-4-0613',
-  GPT432K: 'gpt-4-32k',
-  GPT432K0613: 'gpt-4-32k-0613',
-  GPT3_5Turbo0125: 'gpt-3.5-turbo-0125',
-  GPT3_5Turbo: 'gpt-3.5-turbo',
-  GPT3_5Turbo1106: 'gpt-3.5-turbo-1106',
-  GPT3_5TurboInstruct: 'gpt-3.5-turbo-instruct',
-};
-
-const RunType = {
-  SINGLE_LOOP: 'single-loop',
-  PAIR_WISE_COMPARE: 'pair-wise-compare',
-};
-
-const AnswerSchema = new Schema({
-  prediction: { type: String, required: true },
-  assistantModel: {
-    type: String,
-    enum: Object.values(AssistantModel),
-    required: true,
-  },
-}, { versionKey: false });
-
-const EvalSchema = new Schema({
-  evalData: [
-    {
-      answers: { type: [AnswerSchema] },
-      llmScore: { type: String },
-      llmReasoning: { type: String },
-      humanScore: { type: String },
-      humanReasoning: { type: String },
-    },
-  ],
-  question: { type: String },
-  expectedAnswer: { type: String },
-}, { versionKey: false });
-
-const RunSchema = new mongoose.Schema({
-  name: { type: String },
-  description: { type: String },
-  type: {
-    type: String,
-    enum: Object.values(RunType),
-  },
-  instruction: { type: String },
-  modelName: {
-    type: String,
-    enum: Object.values(ModelName),
-  },
-  evalResults: { type: [EvalSchema], required: true },
-  llmPassRate: { type: Number },
-  humanPassRate: { type: Number },
-}, { timestamps: true, versionKey: false });
-
-// const Run = mongoose.models.Run || mongoose.model('Run', RunSchema);
-// module.exports = { Run, AssistantModel, ModelName, RunType };
-
-module.exports = mongoose.model('Run', RunSchema);
+const mongoose = require('mongoose');
+const { Schema } = mongoose;
+
+const AssistantModel = {
+  Langchain: 'langchain-assistant',
+  OpenAI: 'openAI-assistant',
+};
+
+const ModelName = {
+  GPT4O: 'gpt-4o',
+  GPT4TurboPreview: 'gpt-4-turbo-preview',
+  GPT4Turbo: 'gpt-4-turbo',
+  GPT4Turbo20240409: 'gpt-4-turbo-2024-04-09',
+  GPT40125Preview: 'gpt-4-0125-preview',
+  GPT41106Preview: 'gpt-4-1106-preview',
+  GPT4: 'gpt-4',
+  GPT40613: 'gpt-4-0613',
+  GPT432K: 'gpt-4-32k',
+  GPT432K0613: 'gpt-4-32k-0613',
+  GPT3_5Turbo0125: 'gpt-3.5-turbo-0125',
+  GPT3_5Turbo: 'gpt-3.5-turbo',
+  GPT3_5Turbo1106: 'gpt-3.5-turbo-1106',
+  GPT3_5TurboInstruct: 'gpt-3.5-turbo-instruct',
+};
+
+const RunType = {
+  SINGLE_LOOP: 'single-loop',
+  PAIR_WISE_COMPARE: 'pair-wise-compare',
+};
+
+const AnswerSchema = new Schema({
+  prediction: { type: String, required: true },
+  assistantModel: {
+    type: String,
+    enum: Object.values(AssistantModel),
+    required: true,
+  },
+}, { versionKey: false });
+
+const EvalSchema = new Schema({
+  evalData: [
+    {
+      answers: { type: [AnswerSchema] },
+      llmScore: { type: String },
+      llmReasoning: { type: String },
+      humanScore: { type: String },
+      humanReasoning: { type: String },
+    },
+  ],
+  question: { type: String },
+  expectedAnswer: { type: String },
+}, { versionKey: false });
+
+const RunSchema = new mongoose.Schema({
+  name: { type: String },
+  description: { type: String },
+  type: {
+    type: String,
+    enum: Object.values(RunType),
+  },
+  instruction: { type: String },
+  modelName: {
+    type: String,
+    enum: Object.values(ModelName),
+  },
+  evalResults: { type: [EvalSchema], required: true },
+  llmPassRate: { type: Number },
+  humanPassRate: { type: Schema.Types.Mixed },
+}, { timestamps: true, versionKey: false });
+
+// const Run = mongoose.models.Run || mongoose.model('Run', RunSchema);
+// module.exports = { Run, AssistantModel, ModelName, RunType };
+
+module.exports = mongoose.models.Run || mongoose.model('Run', RunSchema);

package/package.json

@@ -1,15 +1,15 @@
-{
-  "name": "ben-ai-models-registry",
-  "version": "1.0.2",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "mongoose": "^8.4.4"
-  }
-}
+{
+  "name": "ben-ai-models-registry",
+  "version": "1.0.4",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "mongoose": "^8.4.4"
+  }
+}