@or-sdk/qna - npm Package Compare versions

Comparing version 3.3.0-beta.1647.0 to 3.3.0-beta.1722.0

dist/types/types.d.ts

@@ -67,2 +67,3 @@ import { OrderOptions, PaginationOptions, Token } from '@or-sdk/base';
     updatedAt: string;
+    countPassages?: number;
 };
@@ -87,2 +88,3 @@ export type Collection = {
     modelName?: string;
+    countPassages?: number;
 };
@@ -109,7 +111,7 @@ export type SearchResult = {
 export type UpdateCollection = {
-    description?: string | null;
-    imageUrl?: string | null;
-    answerInstruction?: string | null;
-    questionInstruction?: string | null;
-    greetingInstruction?: string | null;
+    description?: string;
+    imageUrl?: string;
+    answerInstruction?: string;
+    questionInstruction?: string;
+    greetingInstruction?: string;
     temperature?: number;
@@ -116,0 +118,0 @@ maxTokens?: number;

package.json

 {
   "name": "@or-sdk/qna",
-  "version": "3.3.0-beta.1647.0",
+  "version": "3.3.0-beta.1722.0",
   "main": "dist/cjs/index.js",
@@ -5,0 +5,0 @@ "module": "dist/esm/index.js",

README.md

@@ -241,25 +241,2 @@ # QnA SDK
 {
-  id: 'a1b2c3d4-uuid',
-  accountId: 'i9j0k1l2-uuid',
-  name: 'Collection With Properties',
-  description: 'A collection with properties'
-  properties: [
-    {
-      id: 'e5f6g7h8-uuid',
-      name: 'author',
-      dataType: 'string',
-      description: 'Author of the document',
-    },
-    {
-      id: 'i9j0k1l2-uuid',
-      name: 'publishDate',
-      dataType: 'date',
-      description: 'Date when the document was published',
-    },
-  ],
-}
-```
-
-// Example response
-{
   id: 'x1y2z3w4-uuid',
@@ -321,2 +298,3 @@ accountId: 'i9j0k1l2-uuid',
   description: 'A sample collection',
+  countPassages: 42,
   properties: [
@@ -357,3 +335,3 @@ {
 -  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.
+-  maxDistance: `number` (optional) - Filters out passages that are further than this value from the question or context. Measured by cosine metric. Default is 0. Range accepted is 0 to 1
 
@@ -368,3 +346,2 @@ #### Example
   limit: 10,
-  maxDistance: 0.5,
   where: {
@@ -605,3 +582,4 @@ operator: 'And',
   name: 'Sample Document',
-  description: 'A sample document'
+  description: 'A sample document',
+  countPassages: 42,
 }
@@ -631,2 +609,3 @@ ```
   description: 'A sample collection',
+  countPassages: 42,
   properties: [
@@ -633,0 +612,0 @@ {

src/types.ts

@@ -115,5 +115,5 @@ import { OrderOptions, PaginationOptions, Token } from '@or-sdk/base';
   /**
-   * Filter out passages that are further then maxDistance from the question or context by
-   * cosine metric (Optional)
-   * Range: [0, 1]
+   * Filter out passages that are further than maxDistance from the question or context by cosine metric.
+   * Default: 0
+   * Range: 0 - 1
    */
@@ -280,2 +280,7 @@ maxDistance?: number;
   updatedAt: string;
+
+  /**
+   * Number of passages in the document.
+   */
+  countPassages?: number;
 };
@@ -384,2 +389,7 @@
   modelName?: string;
+
+  /**
+   * Number of passages in the collection.
+   */
+  countPassages?: number;
 };
@@ -464,3 +474,3 @@
    */
-  description?: string | null;
+  description?: string;
 
@@ -471,3 +481,3 @@ /**
    */
-  imageUrl?: string | null;
+  imageUrl?: string;
 
@@ -478,3 +488,3 @@ /**
    */
-  answerInstruction?: string | null;
+  answerInstruction?: string;
 
@@ -485,3 +495,3 @@ /**
    */
-  questionInstruction?: string | null;
+  questionInstruction?: string;
 
@@ -492,3 +502,3 @@ /**
    */
-  greetingInstruction?: string | null;
+  greetingInstruction?: string;
 
@@ -495,0 +505,0 @@ /**

No alert changes

Improved metrics

Lines of code

2567

increased by0.39%

Worsened metrics

Total package byte prevSize

166340

decreased by-0.15%

Number of lines in readme file

982

decreased by-2.09%

No dependency changes