@or-sdk/lookup 1.1.0 → 1.2.0

package/src/Lookup.ts

@@ -4,7 +4,7 @@ import {
   LoadDocument, CreateCollection, Search, Ask, UpdateCollection,
   UpdateDocument, LookupConfig, Document, Collection, SearchResult,
   AskResults, Find, Property, CreatePassage, Passage, UpdatePassage,
-  DeletedPassage, FindPassages,
+  DeletedPassage, FindPassages, CallOptions,
 } from './types';
 import { createErrorParser, processors } from './error-parser';
 
@@ -27,25 +27,40 @@ export class Lookup extends Base {
     return errorParser(err);
   }
 
-  async loadDocument(collectionId: string, params: LoadDocument): Promise<Document> {
+  /**
+   * Load the document into collection.
+   * @param collectionId - The ID of the collection the document belongs to.
+   * @param params - The document loading parameters.
+   * @param [options] - The API call options.
+   * @returns The created document.
+   */
+  async loadDocument(
+    collectionId: string,
+    params: LoadDocument,
+    options: CallOptions = {},
+  ): Promise<Document> {
     const response = await this.callApiV2<Document>({
       method: 'POST',
       route: `collections/${collectionId}/documents`,
       data: params,
+      ...options,
     });
+
     return response;
   }
 
   /**
    * Create a new collection.
    * @param params - The collection creation parameters.
+   * @param [options={}] - The API call options.
    * @returns The created collection.
    */
-  async createCollection(params: CreateCollection): Promise<Collection> {
+  async createCollection(params: CreateCollection, options: CallOptions = {}): Promise<Collection> {
     const response = await this.callApiV2<Collection>({
       method: 'POST',
       route: 'collections',
       data: params,
+      ...options,
     });
 
     return response;
@@ -55,16 +70,19 @@ export class Lookup extends Base {
    * Create a new passage within the collection.
    * @param collectionId - The ID of the collection the passage belongs to.
    * @param passage - The passage creation parameters.
+   * @param [options={}] - The API call options.
    * @returns The created passage.
    */
   async createPassage<T extends Record<string, unknown>>(
     collectionId: string,
     passage: CreatePassage<T>,
+    options: CallOptions = {},
   ): Promise<Passage<T>> {
     const response = await this.callApiV2<Passage<T>>({
       method: 'POST',
       route: `collections/${collectionId}/passages`,
       data: passage,
+      ...options,
     });
 
     return response;
@@ -74,27 +92,32 @@ export class Lookup extends Base {
    * Create batch of passages within the collection.
    * @param collectionId - The ID of the collection the passage belongs to.
    * @param passages - The passages to create.
+   * @param [options={}] - The API call options.
    */
   async createManyPassages<T extends Record<string, unknown>>(
     collectionId: string,
     passages: CreatePassage<T>[],
+    options: CallOptions = {},
   ): Promise<void> {
     await this.callApiV2({
       method: 'POST',
       route: `collections/${collectionId}/passages/batch`,
       data: passages,
+      ...options,
     });
   }
 
   /**
    * Delete a collection by ID.
    * @param collectionId - The ID of the collection to delete.
+   * @param [options={}] - The API call options.
    * @returns The deleted collection.
    */
-  async deleteCollection(collectionId: string): Promise<Collection> {
+  async deleteCollection(collectionId: string, options: CallOptions = {}): Promise<Collection> {
     const response = await this.callApiV2<Collection>({
       method: 'DELETE',
       route: `collections/${collectionId}`,
+      ...options,
     });
 
     return response;
@@ -104,12 +127,14 @@ export class Lookup extends Base {
    * Delete a passage from a collection.
    * @param collectionId - The ID of the collection the passage belongs to.
    * @param passageId - The ID of the passage to delete.
+   * @param [options={}] - The API call options.
    * @returns The deleted passage.
    */
-  async deletePassage(collectionId: string, passageId: string): Promise<DeletedPassage> {
+  async deletePassage(collectionId: string, passageId: string, options: CallOptions = {}): Promise<DeletedPassage> {
     const response = await this.callApiV2<DeletedPassage>({
       method: 'DELETE',
       route: `collections/${collectionId}/passages/${passageId}`,
+      ...options,
     });
 
     return response;
@@ -119,13 +144,15 @@ export class Lookup extends Base {
    * Search for documents in a collection.
    * @param collectionId - The ID of the collection to search in.
    * @param params - The search parameters.
+   * @param [options={}] - The API call options.
    * @returns An array of search results.
    */
-  async search(collectionId: string, params: Search): Promise<SearchResult[]> {
+  async search(collectionId: string, params: Search, options: CallOptions = {}): Promise<SearchResult[]> {
     const response = await this.callApiV2<SearchResult[]>({
       method: 'POST',
       route: `collections/${collectionId}/search`,
       data: params,
+      ...options,
     });
 
     return response;
@@ -135,13 +162,15 @@ export class Lookup extends Base {
    * Ask a question and generate an answer based on the documents in a collection.
    * @param collectionId - The ID of the collection to use for generating the answer.
    * @param params - The ask question parameters.
+   * @param [options={}] - The API call options.
    * @returns The generated answer and search result.
    */
-  async ask(collectionId: string, params: Ask): Promise<AskResults> {
+  async ask(collectionId: string, params: Ask, options: CallOptions = {}): Promise<AskResults> {
     const response = await this.callApiV2<AskResults>({
       method: 'POST',
       route: `collections/${collectionId}/ask`,
       data: params,
+      ...options,
     });
 
     return response;
@@ -152,13 +181,20 @@ export class Lookup extends Base {
    * @param collectionId - The ID of the collection the document belongs to.
    * @param documentId - The ID of the document to update.
    * @param params - The update document parameters.
+   * @param [options={}] - The API call options.
    * @returns The updated document.
    */
-  async updateDocument(collectionId: string, documentId: string, params: UpdateDocument): Promise<Document> {
+  async updateDocument(
+    collectionId: string,
+    documentId: string,
+    params: UpdateDocument,
+    options: CallOptions = {},
+  ): Promise<Document> {
     const response = await this.callApiV2<Document>({
       method: 'PUT',
       route: `collections/${collectionId}/documents/${documentId}`,
       data: params,
+      ...options,
     });
     return response;
   }
@@ -168,48 +204,62 @@ export class Lookup extends Base {
    * @param collectionId - The ID of the collection the passage belongs to.
    * @param passageId - The ID of the passage to update.
    * @param params - The update passage parameters.
+   * @param [options={}] - The API call options.
    * @returns The updated passage.
    */
   async updatePassage<T extends Record<string, unknown>>(
     collectionId: string,
     passageId: string,
     params: UpdatePassage<T>,
+    options: CallOptions = {},
   ): Promise<Passage<T>> {
     const response = await this.callApiV2<Passage<T>>({
       method: 'PUT',
       route: `collections/${collectionId}/passages/${passageId}`,
       data: params,
+      ...options,
     });
 
     return response;
   }
 
   /**
-   * Update a document's description.
-   * @param collectionId - The ID of the collection the document belongs to.
-   * @param documentId - The ID of the document to update.
-   * @param params - The update document parameters.
-   * @returns The updated document.
+   * Update a collection's description.
+   * @param collectionId - The ID of the collection to update.
+   * @param params - The update collection parameters.
+   * @param [options={}] - The API call options.
+   * @returns The updated collection.
    */
-  async updateCollection(collectionId: string, params: UpdateCollection): Promise<Collection> {
+  async updateCollection(
+    collectionId: string,
+    params: UpdateCollection,
+    options: CallOptions = {},
+  ): Promise<Collection> {
     const response = await this.callApiV2<Collection>({
       method: 'PUT',
       route: `collections/${collectionId}`,
       data: params,
+      ...options,
     });
     return response;
   }
 
   /**
-   * Update a collection's description.
-   * @param collectionId - The ID of the collection to update.
-   * @param params - The update collection parameters.
-   * @returns The updated collection.
+   * Get a document by its ID.
+   * @param collectionId - The ID of the collection the document belongs to.
+   * @param documentId - The ID of the document to retrieve.
+   * @param [options={}] - The API call options.
+   * @returns The retrieved document.
    */
-  async getDocument(collectionId: string, documentId: string): Promise<Document> {
+  async getDocument(
+    collectionId: string,
+    documentId: string,
+    options: CallOptions = {},
+  ): Promise<Document> {
     const response = await this.callApiV2<Document>({
       method: 'GET',
       route: `collections/${collectionId}/documents/${documentId}`,
+      ...options,
     });
     return response;
   }
@@ -217,12 +267,17 @@ export class Lookup extends Base {
   /**
    * Get a collection by its ID.
    * @param collectionId - The ID of the collection to retrieve.
+   * @param [options={}] - The API call options.
    * @returns The retrieved collection.
    */
-  async getCollection(collectionId: string): Promise<Collection> {
+  async getCollection(
+    collectionId: string,
+    options: CallOptions = {},
+  ): Promise<Collection> {
     const response = await this.callApiV2<Collection>({
       method: 'GET',
       route: `collections/${collectionId}`,
+      ...options,
     });
     return response;
   }
@@ -231,12 +286,18 @@ export class Lookup extends Base {
    * Get a single passage from a collection.
    * @param collectionId - The ID of the collection the passage belongs to.
    * @param passageId - The ID of the passage to retrieve.
+   * @param [options={}] - The API call options.
    * @returns The retrieved passage.
    */
-  async getPassage<T extends Record<string, unknown>>(collectionId: string, passageId: string): Promise<Passage<T>> {
+  async getPassage<T extends Record<string, unknown>>(
+    collectionId: string,
+    passageId: string,
+    options: CallOptions = {},
+  ): Promise<Passage<T>> {
     const response = await this.callApiV2<Passage<T>>({
       method: 'GET',
       route: `collections/${collectionId}/passages/${passageId}`,
+      ...options,
     });
 
     return response;
@@ -250,13 +311,19 @@ export class Lookup extends Base {
    *  ['accountId', 'collection', 'document', 'content', 'loaderMetadata', 'sourceUrl']
    * @param collectionId - The ID of the collection to add the property to.
    * @param property - The property to add to the collection.
+   * @param [options={}] - The API call options.
    * @returns A promise that resolves when the property has been added.
    */
-  async addProperty(collectionId: string, property: Property): Promise<void> {
+  async addProperty(
+    collectionId: string,
+    property: Property,
+    options: CallOptions = {},
+  ): Promise<void> {
     await this.callApiV2({
       method: 'POST',
       route: `collections/${collectionId}/properties`,
       data: property,
+      ...options,
     });
   }
 
@@ -264,16 +331,19 @@ export class Lookup extends Base {
    * List all documents in a collection with optional pagination and query.
    * @param collectionId - The ID of the collection to retrieve documents from.
    * @param find - Optional find parameters.
+   * @param [options={}] - The API call options.
    * @returns An array of documents.
    */
   async listDocuments(
     collectionId: string,
     params: Find = {},
+    options: CallOptions = {},
   ): Promise<List<Document>> {
     const response = await this.callApiV2<Document[]>({
       method: 'GET',
       route: `collections/${collectionId}/documents`,
       params,
+      ...options,
     });
 
     return makeList(response);
@@ -281,16 +351,16 @@ export class Lookup extends Base {
 
   /**
    * List collections with optional pagination and query.
-   * @param find - Optional find parameters.
+   * @param params - Optional find parameters.
+   * @param [options={}] - The API call options.
    * @returns An array of collections.
    */
-  async listCollections(
-    params: Find = {},
-  ): Promise<List<Collection>> {
+  async listCollections(params: Find = {}, options: CallOptions = {}): Promise<List<Collection>> {
     const response = await this.callApiV2<Collection[]>({
       method: 'GET',
       route: 'collections',
       params,
+      ...options,
     });
 
     return makeList(response);
@@ -299,17 +369,20 @@ export class Lookup extends Base {
   /**
    * List all passages in a collection with optional pagination and query.
    * @param collectionId - The ID of the collection to retrieve passages from.
-   * @param find - Optional find parameters.
+   * @param params - Optional find parameters.
+   * @param [options={}] - The API call options.
    * @returns An array of passages.
    */
   async listPassages<T extends Record<string, unknown>>(
     collectionId: string,
     params: FindPassages = {},
+    options: CallOptions = {},
   ): Promise<List<Passage<T>>> {
     const response = await this.callApiV2<Passage<T>[]>({
       method: 'GET',
       route: `collections/${collectionId}/passages`,
       params,
+      ...options,
     });
 
     return makeList(response);
@@ -320,17 +393,20 @@ export class Lookup extends Base {
    * @param collectionId - The ID of the collection containing the document.
    * @param documentId - The ID of the document to retrieve passages from.
    * @param find - Optional find parameters.
+   * @param [options={}] - The API call options.
    * @returns An array of passages with pagination info.
    */
   async listPassagesInDocument<T extends Record<string, unknown>>(
     collectionId: string,
     documentId: string,
     find: FindPassages = {},
+    options: CallOptions = {},
   ): Promise<List<Passage<T>>> {
     const response = await this.callApiV2<Passage<T>[]>({
       method: 'GET',
       route: `collections/${collectionId}/documents/${documentId}/passages`,
       params: find,
+      ...options,
     });
 
     return makeList(response);
@@ -340,12 +416,18 @@ export class Lookup extends Base {
    * Delete a document from a collection.
    * @param collectionId - The ID of the collection to delete the document from.
    * @param documentId - The ID of the document to delete.
+   * @param [options={}] - The API call options.
    * @returns The deleted document.
    */
-  async deleteDocument(collectionId: string, documentId: string): Promise<Document> {
+  async deleteDocument(
+    collectionId: string,
+    documentId: string,
+    options: CallOptions = {},
+  ): Promise<Document> {
     const response = await this.callApiV2<Document>({
       method: 'DELETE',
       route: `collections/${collectionId}/documents/${documentId}`,
+      ...options,
     });
 
     return response;

package/src/__tests__/QnA.collections.spec.ts

@@ -3,7 +3,7 @@ import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 
 import { Lookup } from '..';
-import type { LookupConfig, CreateCollection } from '..';
+import type { LookupConfig } from '..';
 
 import collection from './fixtures/collection.json';
 
@@ -91,18 +91,4 @@ describe('Lookup', () => {
       message: 'name must be longer than or equal to 5 characters. Can start only with a letter.',
     });
   });
-
-  it('should show ISE properly', async () => {
-    const lookup = createLookupInstance();
-
-    const promise = lookup.createCollection({
-      ise: true,
-    } as unknown as CreateCollection);
-
-    await expect(promise).rejects.toMatchObject({
-      status: 500,
-      message: 'Internal server error',
-      description: 'Some tech error message here',
-    });
-  });
 });

package/src/error-parser/OrNetworkError.ts

@@ -1,23 +1,17 @@
 type CtorOptions = {
   message: string;
-  description?: string;
   status?: number;
 };
 
 export class OrNetworkError extends Error {
   private _status: number | undefined;
   private _description: string | undefined;
-  constructor({ description, message, status }: CtorOptions) {
+  constructor({ message, status }: CtorOptions) {
     super(message);
     this._status = status;
-    this._description = description;
   }
 
   get status() {
     return this._status;
   }
-
-  get description() {
-    return this._description;
-  }
 }

package/src/error-parser/parse-axios-error.ts

@@ -14,16 +14,9 @@ export function parseAxiosError(e: AxiosError): Error {
     const generalMessage = MESSAGES[status] || e.message;
     const message = normalizeMessage(data.message || data.error) || generalMessage;
 
-    if (status < 500) {
-      return new OrNetworkError({
-        message,
-        status,
-      });
-    }
     return new OrNetworkError({
-      message: generalMessage,
+      message,
       status,
-      description: message,
     });
   }
 

package/src/types.ts

@@ -4,6 +4,10 @@ export type { OrNetworkError } from './error-parser';
 
 export type SearchMode = 'vector' | 'bm25';
 
+export type CallOptions = {
+  signal?: AbortSignal;
+};
+
 export type LookupConfig = {
   /**
    * token