@or-sdk/qna - npm Package Compare versions

Comparing version 3.2.0 to 3.3.0-beta.1618.0

dist/types/types.d.ts

@@ -30,2 +30,3 @@ import { OrderOptions, PaginationOptions, Token } from '@or-sdk/base';
     select?: string[];
+    maxDistance?: number;
 };
@@ -107,7 +108,7 @@ export type MessageRole = 'user' | 'assistant';
 export type UpdateCollection = {
-    description?: string;
-    imageUrl?: string;
-    answerInstruction?: string;
-    questionInstruction?: string;
-    greetingInstruction?: string;
+    description?: string | null;
+    imageUrl?: string | null;
+    answerInstruction?: string | null;
+    questionInstruction?: string | null;
+    greetingInstruction?: string | null;
     temperature?: number;
@@ -114,0 +115,0 @@ maxTokens?: number;

package.json

 {
   "name": "@or-sdk/qna",
-  "version": "3.2.0",
+  "version": "3.3.0-beta.1618.0",
   "main": "dist/cjs/index.js",
@@ -36,4 +36,3 @@ "module": "dist/esm/index.js",
     "access": "public"
-  },
-  "gitHead": "a34689439fdd2c688af7aef2059dd88b20adae6c"
+  }
 }

README.md

@@ -355,2 +355,3 @@ # QnA SDK
 -  select: `string[]` (optional) - An array of custom properties to include in the results
+-  maxDistance: `number` (optional) - Value to filter out passages that are further than this value from the question or context. If present, it must be a number between 0 and 1.
 
@@ -365,2 +366,3 @@ #### Example
   limit: 10,
+  maxDistance: 0.5,
   where: {
@@ -367,0 +369,0 @@ operator: 'And',

src/types.ts

@@ -113,2 +113,9 @@ import { OrderOptions, PaginationOptions, Token } from '@or-sdk/base';
   select?: string[];
+
+  /**
+   * Filter out passages that are further then maxDistance from the question or context by
+   * cosine metric (Optional)
+   * Range: [0, 1]
+   */
+  maxDistance?: number;
 };
@@ -455,3 +462,3 @@
    */
-  description?: string;
+  description?: string | null;
 
@@ -462,3 +469,3 @@ /**
    */
-  imageUrl?: string;
+  imageUrl?: string | null;
 
@@ -469,3 +476,3 @@ /**
    */
-  answerInstruction?: string;
+  answerInstruction?: string | null;
 
@@ -476,3 +483,3 @@ /**
    */
-  questionInstruction?: string;
+  questionInstruction?: string | null;
 
@@ -483,3 +490,3 @@ /**
    */
-  greetingInstruction?: string;
+  greetingInstruction?: string | null;
 
@@ -486,0 +493,0 @@ /**

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

166597

increased by0.31%

Lines of code

2557

increased by0.27%

Number of lines in readme file

1003

increased by0.2%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes