ben-ai-models-registry 1.0.34 → 1.0.35

package/README.md

@@ -16,19 +16,40 @@ 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
-
+   ```js
    import { Run, JobStatus, LanguageObject } from 'ben-ai-models-registry';
+   ```
 
+### Modifying the Model Locally for Another Project
 
-## Usage in Other Applications
+If you need to adapt the models for a specific project without immediately publishing changes to the `ben-ai-models-registry` package, you can modify them locally:
+
+1. Navigate to the `ben-ai-models-registry` folder within your project's `node_modules` directory:
+
+   ```
+   <your_project>\node_modules\ben-ai-models-registry
+   ```
 
-If you need to make changes to the models, follow these steps:
+2. Make your changes directly in the local files of the `ben-ai-models-registry` package.
+
+3. To ensure your project uses the locally modified version, update the `package.json` file in your project (located at `<your_project>\package.json`) by specifying a local file dependency:
+
+   ```json
+   "dependencies": {
+       "ben-ai-models-registry": "file:../ben-ai-models-registry"
+   }
+   ```
+
+   **Note**: Adjust the relative path (`../ben-ai-models-registry`) based on the location of the ben-ai-models-registry folder relative to your project.
+
+4. Run `npm install` in your project directory to apply the changes and link the local version of the package.
+
+### Publishing Changes to the ben-ai-models-registry Package:
 
 1. Clone the repository
 2. Make your changes.
@@ -37,11 +58,14 @@ If you need to make changes to the models, follow these steps:
 
    ```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.
+**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/models/Run.js

@@ -4,6 +4,8 @@ const { Schema } = mongoose;
 const AssistantModel = {
   Langchain: "langchain-assistant",
   OpenAI: "openAI-assistant",
+  Langchain: "langchain-assistant",
+  OpenAI: "openAI-assistant",
 };
 
 const ModelName = {
@@ -22,11 +24,28 @@ const ModelName = {
   GPT3_5Turbo: "gpt-3.5-turbo",
   GPT3_5Turbo1106: "gpt-3.5-turbo-1106",
   GPT3_5TurboInstruct: "gpt-3.5-turbo-instruct",
+  GPT4O: "gpt-4o",
+  GPT4OMini: "gpt-4o-mini",
+  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",
+  SINGLE_LOOP: "single-loop",
+  PAIR_WISE_COMPARE: "pair-wise-compare",
 };
 
 const AnswerSchema = new Schema(
@@ -56,7 +75,7 @@ const AnswerSchema = new Schema(
 const EvaluationQuestionSchema = new Schema(
   {
     question: { type: String },
-    score: { type: String },
+    score: { type: Number },
     reasoning: { type: String },
   },
   { versionKey: false }
@@ -67,17 +86,24 @@ const EvaluationSchema = new Schema(
     criterion: { type: String },
     questions: [EvaluationQuestionSchema],
     reasoning: { type: String },
-    overallScore: { type: String },
+    overallScore: { type: Number },
   },
   { timestamps: true, versionKey: false }
 );
 
+const RagEvaluation = new Schema({
+  correctness: { type: EvaluationQuestionSchema },
+  relevance: { type: EvaluationQuestionSchema },
+  groundedness: { type: EvaluationQuestionSchema },
+  retrievalRelevance: { type: EvaluationQuestionSchema },
+});
+
 const EvalSchema = new Schema(
   {
     evalData: [
       {
         answers: { type: [AnswerSchema] },
-        llmEvaluation: { type: EvaluationSchema },
+        llmEvaluation: { type: RagEvaluation },
         humanEvaluation: { type: [EvaluationSchema] },
         humanOverallScore: { type: String },
       },
@@ -108,8 +134,12 @@ const RunSchema = new mongoose.Schema(
     },
     evalResults: { type: [EvalSchema], required: true },
     llmPassRate: { type: Schema.Types.Mixed },
+    relevanceScore: { type: Schema.Types.Mixed },
+    groundednessScore: { type: Schema.Types.Mixed },
+    retrievalRelevanceScore: { type: Schema.Types.Mixed },
     humanPassRate: { type: Schema.Types.Mixed },
     totalScore: { type: Schema.Types.Mixed },
+    numberOfRetrievedDocs: { type: Number },
   },
   { timestamps: true, versionKey: false }
 );

package/models/User.js

@@ -3,7 +3,12 @@ const { Schema } = mongoose;
 
 const UserSchema = new Schema(
 	{
-		email: { type: String, unique: true, required: true },
+	email: { type: String, required: true, unique: true },
+    firstName: { type: String, required: true },
+    lastName: { type: String, required: true },
+    organization: { type: String, required: true },
+    acceptedTerms: { type: Boolean, required: true },
+    acceptedFutureContact: { type: Boolean, default: false },
 		refName: {
 			type: String,
 		},
@@ -13,4 +18,4 @@ const UserSchema = new Schema(
 	{ timestamps: true, versionKey: false }
 );
 
-module.exports = mongoose.models.User || mongoose.model("User", UserSchema);
+module.exports = mongoose.models.User || mongoose.model("User", UserSchema);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ben-ai-models-registry",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "description": "",
   "main": "index.js",
   "scripts": {