@or-sdk/lookup 1.9.2 → 1.10.0-beta.2478.0

package/README.md

@@ -189,6 +189,7 @@ Creates a new collection with optional properties. A collection is a group of re
   - `presencePenalty`: `number` (optional) - Value to penalize new tokens based on their presence in existing text. If present, it must be a number between -2 and 2.
   - `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.
   - `modelName`: `string` (optional) - Name of the large language model to be used. It can't be more than 64 characters long.
+  - `type`: `CollectionType` (optional) - it allow for post process passages content(QnA), or create specific properties(IDW skills).
 
 #### Example
 Creating a collection with a name, description, and additional instructions
@@ -210,7 +211,8 @@ const collection = await lookup.createCollection({
   frequencyPenalty: 0.8,
   presencePenalty: 1,
   maxDistance: 0.5,
-  modelName: 'text-davinci-002'
+  modelName: 'text-davinci-002',
+  type: 'DEFAULT'
 });
 
 console.log(collection);
@@ -374,7 +376,8 @@ const searchResults = await lookup.search(collectionId, {
     document: {
       id: 'i9j0k1l2-uuid',
       name: 'Document Name'
-    }
+    },
+    select: ['author', 'publishDate']
   }
 ]
 ```
@@ -457,6 +460,7 @@ const askResults = await lookup.ask(collectionId, {
 // Example response
 {
   result: { role: 'assistant', content: 'The meaning of life is 42.' },
+  select: ['title', 'author', 'publishDate'],
   searchResult: [
     {
       id: 'e5f6g7h8-uuid',
@@ -468,6 +472,7 @@ const askResults = await lookup.ask(collectionId, {
         id: 'i9j0k1l2-uuid',
         name: 'On the Meaning of Life',
       },
+      select: ['title', 'author', 'publishDate']
       title: 'On the Meaning of Life',
       author: 'John Doe',
       publishDate: '2020-12-31',
@@ -743,7 +748,9 @@ Create a passage and add it to a specific document within a collection. A passag
 #### Params
 -  collectionId: `string` - The ID of the collection the document belongs to
 -  params: `CreatePassage` - An object containing parameters required to create a passage
-  - `content` (string): The content of the passage to be created
+  - `content` (optional): The content of the passage for DEFAULT collection type
+  - `question` (optional): The question of the passage for QNA_V1 collection type
+  - `answer` (optional): The answer of the passage for QNA_V1 collection type
   - `documentId` (string): The ID of the document the passage will be associated with
   - `property: value` (optional): Custom properties of the passage. Note that these properties should be listed in the collection properties
 
@@ -774,7 +781,9 @@ Create a batch of passages and add it to a specific document within a collection
 #### Params
 -  collectionId: `string` - The ID of the collection the document belongs to
 -  passages: `CreatePassage[]` - An array of objects containing parameters required to create each passage
-  - `content` (string): The content of the passage to be created
+  - `content` (optional): The content of the passage for DEFAULT collection type
+  - `question` (optional): The question of the passage for QNA_V1 collection type
+  - `answer` (optional): The answer of the passage for QNA_V1 collection type
   - `documentId` (string): The ID of the document the passage will be associated with
   - `property: value` (optional): Custom properties of the passage. Note that these properties should be listed in the collection properties
 

package/dist/cjs/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BackupStatus = exports.DocumentStatus = void 0;
+exports.CollectionType = exports.BackupStatus = exports.DocumentStatus = void 0;
 var DocumentStatus;
 (function (DocumentStatus) {
     DocumentStatus["NEW"] = "NEW";
@@ -14,4 +14,10 @@ var BackupStatus;
     BackupStatus["RESTORE"] = "RESTORE";
     BackupStatus["READY"] = "READY";
 })(BackupStatus = exports.BackupStatus || (exports.BackupStatus = {}));
+var CollectionType;
+(function (CollectionType) {
+    CollectionType["DEFAULT"] = "DEFAULT";
+    CollectionType["QNA_V1"] = "QNA_V1";
+    CollectionType["IDW_V1"] = "IDW_V1";
+})(CollectionType = exports.CollectionType || (exports.CollectionType = {}));
 //# sourceMappingURL=types.js.map

package/dist/cjs/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAkRA,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,qCAAmB,CAAA;IACnB,iCAAe,CAAA;IACf,iCAAe,CAAA;AACjB,CAAC,EALW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAKzB;AAKD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;AACjB,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAuRA,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,qCAAmB,CAAA;IACnB,iCAAe,CAAA;IACf,iCAAe,CAAA;AACjB,CAAC,EALW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAKzB;AAKD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;AACjB,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAKD,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AACnB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB"}

package/dist/esm/types.js

@@ -11,4 +11,10 @@ export var BackupStatus;
     BackupStatus["RESTORE"] = "RESTORE";
     BackupStatus["READY"] = "READY";
 })(BackupStatus || (BackupStatus = {}));
+export var CollectionType;
+(function (CollectionType) {
+    CollectionType["DEFAULT"] = "DEFAULT";
+    CollectionType["QNA_V1"] = "QNA_V1";
+    CollectionType["IDW_V1"] = "IDW_V1";
+})(CollectionType || (CollectionType = {}));
 //# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAkRA,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,qCAAmB,CAAA;IACnB,iCAAe,CAAA;IACf,iCAAe,CAAA;AACjB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AAKD,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;AACjB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAuRA,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,qCAAmB,CAAA;IACnB,iCAAe,CAAA;IACf,iCAAe,CAAA;AACjB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AAKD,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;AACjB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAKD,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AACnB,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB"}

package/dist/types/types.d.ts

@@ -33,6 +33,7 @@ export type Property = {
 export type CreateCollection = UpdateCollection & {
     name: string;
     properties?: Property[];
+    type?: CollectionType;
 };
 export type Search = {
     query: string;
@@ -73,6 +74,11 @@ export declare enum BackupStatus {
     RESTORE = "RESTORE",
     READY = "READY"
 }
+export declare enum CollectionType {
+    DEFAULT = "DEFAULT",
+    QNA_V1 = "QNA_V1",
+    IDW_V1 = "IDW_V1"
+}
 export type DocumentProperty = {
     name: string;
     value?: any;
@@ -109,6 +115,7 @@ export type Collection = {
     maxDistance?: number;
     modelName?: string;
     countPassages?: number;
+    type?: CollectionType;
 };
 export type SearchResult = {
     id: string;
@@ -120,10 +127,12 @@ export type SearchResult = {
         id: string;
         name: string;
     };
+    select: string[];
 };
 export type AskResults = {
     result: CompletionRequestMessage;
     searchResult: SearchResult;
+    select: string[];
 };
 export type UpdateDocument = {
     description?: string;
@@ -150,20 +159,22 @@ export type Find = Partial<PaginationOptions> & Partial<OrderOptions> & {
 export type FindPassages = Find & {
     where?: Record<string, unknown>;
 };
-export type CreatePassage<T extends Record<string, unknown> = Record<string, unknown>> = {
+type TypedPassageProperties = {
     content: string;
+} | {
+    question: string;
+    answer: string;
+};
+export type CreatePassage<T extends Record<string, unknown> = Record<string, unknown>> = TypedPassageProperties & {
     documentId: string;
     loaderMetadata?: Record<string, unknown>;
 } & T;
-export type Passage<T extends Record<string, unknown> = Record<string, unknown>> = {
+export type Passage<T extends Record<string, unknown> = Record<string, unknown>> = TypedPassageProperties & {
     id: string;
-    content: string;
     createdAt: string;
     updatedAt: string;
 } & T;
-export type UpdatePassage<T extends Record<string, unknown> = Record<string, unknown>> = {
-    content: string;
-} & T;
+export type UpdatePassage<T extends Record<string, unknown> = Record<string, unknown>> = TypedPassageProperties & T;
 export type DeletedPassage = {
     id: string;
 };

package/dist/types/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACtE,YAAY,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE3C,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAIzB,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IAIzB,IAAI,EAAE,MAAM,CAAC;IAKb,GAAG,CAAC,EAAE,MAAM,CAAC;IAKb,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAKF,MAAM,MAAM,cAAc,GAAG;IAI3B,GAAG,EAAE,MAAM,CAAC;IAIZ,MAAM,EAAE,MAAM,CAAC;IAIf,KAAK,EAAE,MAAM,CAAC;IAKd,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IAIrB,IAAI,EAAE,MAAM,CAAC;IAKb,QAAQ,EAAE,MAAM,CAAC;IAKjB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAC;IAK9B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAKF,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG;IAMhD,IAAI,EAAE,MAAM,CAAC;IAMb,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;CACzB,CAAC;AAKF,MAAM,MAAM,MAAM,GAAG;IAInB,KAAK,EAAE,MAAM,CAAC;IAKd,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKhC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAOlB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,WAAW,CAAC;AAC/C,MAAM,MAAM,OAAO,GAAG,cAAc,GAAG,KAAK,CAAC;AAK7C,MAAM,MAAM,wBAAwB,GAAG;IAIrC,IAAI,EAAE,WAAW,CAAC;IAKlB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAKF,MAAM,MAAM,GAAG,GAAG;IAIhB,QAAQ,EAAE,MAAM,CAAC;IAMjB,QAAQ,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAOtC,KAAK,CAAC,EAAE,MAAM,CAAC;IAMf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAMhC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAOlB,IAAI,CAAC,EAAE,OAAO,CAAC;IAOf,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAOlC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAOpC,WAAW,CAAC,EAAE,MAAM,CAAC;IAOrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAOnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAO1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAOzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAKF,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAKD,oBAAY,YAAY;IACtB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,gBAAgB,GAAG;IAI7B,IAAI,EAAE,MAAM,CAAC;IAKb,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC;AAKF,MAAM,MAAM,QAAQ,GAAG;IAIrB,EAAE,EAAE,MAAM,CAAC;IAKX,UAAU,EAAE,MAAM,CAAC;IAKnB,IAAI,EAAE,MAAM,CAAC;IAKb,WAAW,EAAE,MAAM,CAAC;IAKpB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAKhC,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC;IAKhC,SAAS,EAAE,MAAM,CAAC;IAKlB,SAAS,EAAE,MAAM,CAAC;IAKlB,aAAa,CAAC,EAAE,MAAM,CAAC;IAKvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAKF,MAAM,MAAM,UAAU,GAAG;IAIvB,EAAE,EAAE,MAAM,CAAC;IAKX,SAAS,EAAE,MAAM,CAAC;IAOlB,IAAI,EAAE,MAAM,CAAC;IAMb,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,MAAM,CAAC,EAAE,YAAY,CAAC;IAMtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAMlC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAMpC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAMpC,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;IAKxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAKzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAMzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAMnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAM1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAMzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IAIzB,EAAE,EAAE,MAAM,CAAC;IAKX,QAAQ,EAAE,MAAM,CAAC;IAKjB,OAAO,EAAE,MAAM,CAAC;IAKhB,SAAS,EAAE,MAAM,CAAC;IAKlB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKxC,QAAQ,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAKF,MAAM,MAAM,UAAU,GAAG;IAIvB,MAAM,EAAE,wBAAwB,CAAC;IAKjC,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAMF,MAAM,MAAM,cAAc,GAAG;IAI3B,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;IAMjC,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACjC,CAAC;AAKF,MAAM,MAAM,gBAAgB,GAAG;IAK7B,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAM3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAM7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAM7B,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAMnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAM1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAOzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAKF,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG;IAItE,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG;IAIhC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC,CAAC;AAKF,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAIvF,OAAO,EAAE,MAAM,CAAC;IAKhB,UAAU,EAAE,MAAM,CAAC;IAKnB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1C,GAAG,CAAC,CAAC;AAKN,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAIjF,EAAE,EAAE,MAAM,CAAC;IAKX,OAAO,EAAE,MAAM,CAAC;IAKhB,SAAS,EAAE,MAAM,CAAC;IAKlB,SAAS,EAAE,MAAM,CAAC;CACnB,GAAG,CAAC,CAAC;AAMN,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAIvF,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,CAAC,CAAC;AAKN,MAAM,MAAM,cAAc,GAAG;IAI3B,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAKF,MAAM,MAAM,wBAAwB,GAAG;IAIrC,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAMF,MAAM,MAAM,MAAM,GAAG;IAKnB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAKF,MAAM,MAAM,OAAO,GAAG;IAKpB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAKF,MAAM,MAAM,yBAAyB,GAAG;IAItC,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAI9B,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACtE,YAAY,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE3C,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAIzB,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IAIzB,IAAI,EAAE,MAAM,CAAC;IAKb,GAAG,CAAC,EAAE,MAAM,CAAC;IAKb,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAKF,MAAM,MAAM,cAAc,GAAG;IAI3B,GAAG,EAAE,MAAM,CAAC;IAIZ,MAAM,EAAE,MAAM,CAAC;IAIf,KAAK,EAAE,MAAM,CAAC;IAKd,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IAIrB,IAAI,EAAE,MAAM,CAAC;IAKb,QAAQ,EAAE,MAAM,CAAC;IAKjB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAC;IAK9B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAKF,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG;IAMhD,IAAI,EAAE,MAAM,CAAC;IAMb,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;IAKxB,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB,CAAC;AAKF,MAAM,MAAM,MAAM,GAAG;IAInB,KAAK,EAAE,MAAM,CAAC;IAKd,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKhC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAOlB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,WAAW,CAAC;AAC/C,MAAM,MAAM,OAAO,GAAG,cAAc,GAAG,KAAK,CAAC;AAK7C,MAAM,MAAM,wBAAwB,GAAG;IAIrC,IAAI,EAAE,WAAW,CAAC;IAKlB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAKF,MAAM,MAAM,GAAG,GAAG;IAIhB,QAAQ,EAAE,MAAM,CAAC;IAMjB,QAAQ,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAOtC,KAAK,CAAC,EAAE,MAAM,CAAC;IAMf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAMhC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAOlB,IAAI,CAAC,EAAE,OAAO,CAAC;IAOf,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAOlC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAOpC,WAAW,CAAC,EAAE,MAAM,CAAC;IAOrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAOnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAO1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAOzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAKF,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAKD,oBAAY,YAAY;IACtB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAKD,oBAAY,cAAc;IACxB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,gBAAgB,GAAG;IAI7B,IAAI,EAAE,MAAM,CAAC;IAKb,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC;AAKF,MAAM,MAAM,QAAQ,GAAG;IAIrB,EAAE,EAAE,MAAM,CAAC;IAKX,UAAU,EAAE,MAAM,CAAC;IAKnB,IAAI,EAAE,MAAM,CAAC;IAKb,WAAW,EAAE,MAAM,CAAC;IAKpB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAKhC,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC;IAKhC,SAAS,EAAE,MAAM,CAAC;IAKlB,SAAS,EAAE,MAAM,CAAC;IAKlB,aAAa,CAAC,EAAE,MAAM,CAAC;IAKvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAKF,MAAM,MAAM,UAAU,GAAG;IAIvB,EAAE,EAAE,MAAM,CAAC;IAKX,SAAS,EAAE,MAAM,CAAC;IAOlB,IAAI,EAAE,MAAM,CAAC;IAMb,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,MAAM,CAAC,EAAE,YAAY,CAAC;IAMtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAMlC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAMpC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAMpC,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;IAKxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAKzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAMzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAMnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAM1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAMzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAKvB,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IAIzB,EAAE,EAAE,MAAM,CAAC;IAKX,QAAQ,EAAE,MAAM,CAAC;IAKjB,OAAO,EAAE,MAAM,CAAC;IAKhB,SAAS,EAAE,MAAM,CAAC;IAKlB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKxC,QAAQ,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAKF,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAKF,MAAM,MAAM,UAAU,GAAG;IAIvB,MAAM,EAAE,wBAAwB,CAAC;IAKjC,YAAY,EAAE,YAAY,CAAC;IAK3B,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAMF,MAAM,MAAM,cAAc,GAAG;IAI3B,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;IAMjC,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACjC,CAAC;AAKF,MAAM,MAAM,gBAAgB,GAAG;IAK7B,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAM3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAM7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAM7B,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAMnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAM1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAOzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAKF,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG;IAItE,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG;IAIhC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAI5B,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG;IAIF,QAAQ,EAAE,MAAM,CAAC;IAIjB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAKF,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,sBAAsB,GAAG;IAIhH,UAAU,EAAE,MAAM,CAAC;IAKnB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1C,GAAG,CAAC,CAAC;AAKN,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,sBAAsB,GAAG;IAI1G,EAAE,EAAE,MAAM,CAAC;IAKX,SAAS,EAAE,MAAM,CAAC;IAKlB,SAAS,EAAE,MAAM,CAAC;CACnB,GAAG,CAAC,CAAC;AAMN,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,sBAAsB,GAAG,CAAC,CAAC;AAKpH,MAAM,MAAM,cAAc,GAAG;IAI3B,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAKF,MAAM,MAAM,wBAAwB,GAAG;IAIrC,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAMF,MAAM,MAAM,MAAM,GAAG;IAKnB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAKF,MAAM,MAAM,OAAO,GAAG;IAKpB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAKF,MAAM,MAAM,yBAAyB,GAAG;IAItC,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAI9B,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/lookup",
-  "version": "1.9.2",
+  "version": "1.10.0-beta.2478.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -33,6 +33,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "bfb1545cd6728b8da3a8c2c47d630a1482db77df"
+  }
 }

package/src/types.ts

@@ -126,6 +126,11 @@ export type CreateCollection = UpdateCollection & {
    * Type: Array<Property>
    */
   properties?: Property[];
+
+  /**
+   * Collection type, it will be used for specific document loading post-processing. (Optional)
+   */
+  type?: CollectionType;
 };
 
 /**
@@ -288,6 +293,15 @@ export enum BackupStatus {
   READY = 'READY',
 }
 
+/**
+ * CollectionType represents the type of a collection.
+ */
+export enum CollectionType {
+  DEFAULT = 'DEFAULT',
+  QNA_V1 = 'QNA_V1',
+  IDW_V1 = 'IDW_V1',
+}
+
 export type DocumentProperty = {
   /**
    * Property name. e.g. `nameOfTheAuthor`
@@ -466,6 +480,11 @@ export type Collection = {
    * Number of passages in the collection.
    */
   countPassages?: number;
+
+  /**
+   * Collection type, it will be used for specific document loading post-processing. (Optional)
+   */
+  type?: CollectionType;
 };
 
 /**
@@ -504,6 +523,11 @@ export type SearchResult = {
     id: string;
     name: string;
   };
+
+  /**
+   * Used properties in search.
+   */
+  select: string[];
 };
 
 /**
@@ -519,6 +543,11 @@ export type AskResults = {
    * Search result for the input question.
    */
   searchResult: SearchResult;
+
+  /**
+   * Used properties in search.
+   */
+  select: string[];
 };
 
 
@@ -640,15 +669,26 @@ export type FindPassages = Find & {
   where?: Record<string, unknown>;
 };
 
-/**
- * Passage creation parameters. The properties other than listed are considered custom properties.
- */
-export type CreatePassage<T extends Record<string, unknown> = Record<string, unknown>> = {
+type TypedPassageProperties = {
   /**
-   * Content of the passage
+   * Content of the default collection passage
    */
   content: string;
+} | {
+  /**
+   * question of the QnA collection passage
+   */
+  question: string;
+  /**
+   * answer of the QnA collection passage
+   */
+  answer: string;
+};
 
+/**
+ * Passage creation parameters. The properties other than listed are considered custom properties.
+ */
+export type CreatePassage<T extends Record<string, unknown> = Record<string, unknown>> = TypedPassageProperties & {
   /**
    * Document ID
    */
@@ -663,17 +703,12 @@ export type CreatePassage<T extends Record<string, unknown> = Record<string, unk
 /**
  * Passage represents a passage object.
  */
-export type Passage<T extends Record<string, unknown> = Record<string, unknown>> = {
+export type Passage<T extends Record<string, unknown> = Record<string, unknown>> = TypedPassageProperties & {
   /**
    * Passage ID
    */
   id: string;
 
-  /**
-   * Passage Content
-   */
-  content: string;
-
   /**
    * Creation Date
    */
@@ -689,12 +724,7 @@ export type Passage<T extends Record<string, unknown> = Record<string, unknown>>
 /**
  * Update passage parameters
  */
-export type UpdatePassage<T extends Record<string, unknown> = Record<string, unknown>> = {
-  /**
-   * Updated content of the passage
-   */
-  content: string;
-} & T;
+export type UpdatePassage<T extends Record<string, unknown> = Record<string, unknown>> = TypedPassageProperties & T;
 
 /**
  * Represents a deleted passage.