@or-sdk/qna - npm Package Compare versions

Comparing version 3.2.0-beta.1575.0 to 3.2.0-beta.1578.0

dist/types/types.d.ts

@@ -90,3 +90,8 @@ import { OrderOptions, PaginationOptions, Token } from '@or-sdk/base';
     content: string;
-    metadata: Record<string, unknown>;
+    sourceUrl: string;
+    loaderMetadata: Record<string, unknown>;
+    document: {
+        id: string;
+        name: string;
+    };
 };
@@ -93,0 +98,0 @@ export type AskResults = {

package.json

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

README.md

@@ -388,4 +388,10 @@ # QnA SDK
     content: 'Found passage content',
-    author: 'John Doe',
-    publishDate: '2020-12-31'
+    sourceUrl: 'http://example.com/source-url',
+    loaderMetadata: {
+      custom: 'metadata'
+    },
+    document: {
+      id: 'i9j0k1l2-uuid',
+      name: 'Document Name'
+    }
   }
@@ -395,3 +401,3 @@ ]
 
-In this example, the `search` method is called with advanced filtering and property selection options. The `where` parameter is used to filter the results based on the `publishDate` property, and the `select` parameter is used to include the `author` and `publishDate` properties of the selected passages in the response. As a result, the search returns a list of passages that meet the specified conditions and include the custom property values.
+In this example, the `search` method is called with advanced filtering and property selection options. The `where` parameter is used to filter the results based on the `publishDate` property, and the `select` parameter is used to include the `author` and `publishDate` properties of the selected passages in the response. As a result, the search returns a list of passages that meet the specified conditions and include the custom property values. Along with these properties, the result also includes new properties like `sourceUrl`, `loaderMetadata` and `document`.
 
@@ -479,2 +485,9 @@ ### `ask`
       content: 'Found passage content',
+      sourceUrl: 'https://example.com/meaning-of-life',
+      loaderMetadata: {...},
+      document: {
+        id: 'i9j0k1l2-uuid',
+        name: 'On the Meaning of Life',
+      },
+      title: 'On the Meaning of Life',
       author: 'John Doe',
@@ -488,2 +501,3 @@ publishDate: '2020-12-31',
 
+
 ### `updateDocument`
@@ -490,0 +504,0 @@

src/types.ts

@@ -397,5 +397,18 @@ import { OrderOptions, PaginationOptions, Token } from '@or-sdk/base';
   /**
+   * SourceUrl
+   */
+  sourceUrl: string;
+
+  /**
    * Found passage metadata.
    */
-  metadata: Record<string, unknown>;
+  loaderMetadata: Record<string, unknown>;
+
+  /**
+   * Found passage metadata.
+   */
+  document: {
+    id: string;
+    name: string;
+  };
 };
@@ -402,0 +415,0 @@

No alert changes

Improved metrics

Total package byte prevSize

165730

increased by0.49%

Lines of code

2556

increased by0.63%

Number of lines in readme file

1001

increased by1.42%

No dependency changes