@or-sdk/lookup 1.23.1 → 1.24.0-beta.4074.0

package/dist/cjs/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AA6SA,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,qCAAmB,CAAA;IACnB,iCAAe,CAAA;IACf,iCAAe,CAAA;AACjB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAKD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,+BAAe,CAAA;AACjB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAKD,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AACnB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAuTA,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,qCAAmB,CAAA;IACnB,iCAAe,CAAA;IACf,iCAAe,CAAA;AACjB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAKD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,+BAAe,CAAA;AACjB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAKD,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AACnB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB"}

package/dist/esm/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AA6SA,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,YAKX;AALD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,+BAAe,CAAA;AACjB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAKD,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AACnB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAuTA,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,YAKX;AALD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,+BAAe,CAAA;AACjB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAKD,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AACnB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB"}

package/dist/types/Lookup.d.ts

@@ -7,38 +7,240 @@ export declare class Lookup extends Base {
     constructor(params: LookupConfig);
     private makeRequest;
     parseError(err: unknown): Error;
+    /**
+     * Retrieves the AI providers.
+     * @returns {Promise<ProvidersList>} A promise that resolves with the AI providers.
+     */
     getAiProviders(): Promise<ProvidersList>;
+    /**
+     * 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.
+     */
     loadDocument(collectionId: string, params: LoadDocument, options?: CallOptions): Promise<Document>;
+    /**
+     * @param collectionId - The ID of the collection the document belongs to.
+     * @param params - The document crawling parameters.
+     * @param [options] - The API call options.
+     */
     loadCrawlerDocument(collectionId: string, params: CrawlDocuments, options?: CallOptions): Promise<void>;
+    /**
+     * Create a new collection.
+     * @param params - The collection creation parameters.
+     * @param [options={}] - The API call options.
+     * @returns The created collection.
+     */
     createCollection(params: CreateCollection, options?: CallOptions): Promise<Collection>;
+    /**
+     * 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.
+     */
     createPassage<T extends Record<string, unknown>>(collectionId: string, passage: CreatePassage<T>, options?: CallOptions): Promise<Passage<T>>;
+    /**
+     * 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.
+     */
     createManyPassages<T extends Record<string, unknown>>(collectionId: string, passages: CreatePassage<T>[], options?: CallOptions): Promise<void>;
+    /**
+     * Delete a collection by ID.
+     * @param collectionId - The ID of the collection to delete.
+     * @param [options={}] - The API call options.
+     * @returns The deleted collection.
+     */
     deleteCollection(collectionId: string, options?: CallOptions): Promise<Collection>;
+    /**
+     * Delete a passage from a collection.
+     * @param collectionId - The ID of the collection the passage belongs to.
+     * @param documentId - The ID of the passage to delete.
+     * @param ids - The IDs of the passages to delete.
+     * @param [options={}] - The API call options.
+     * @returns The deleted passage.
+     */
     deleteManyPassages(collectionId: string, documentId: string, ids: string[], options?: CallOptions): Promise<RemoveManyPassagesResult>;
+    /**
+     * 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.
+     */
     deletePassage(collectionId: string, passageId: string, options?: CallOptions): Promise<DeletedPassage>;
+    /**
+     * 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.
+     */
     search(collectionId: string, params: Search, options?: CallOptions): Promise<SearchResult[]>;
+    /**
+     * 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.
+     */
     ask(collectionId: string, params: Ask, options?: CallOptions): Promise<AskResults>;
+    /**
+     * 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.
+     * @param [options={}] - The API call options.
+     * @returns The updated document.
+     */
     updateDocument(collectionId: string, documentId: string, params: UpdateDocument, options?: CallOptions): Promise<Document>;
+    /**
+     * Update a passage in a collection.
+     * @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.
+     */
     updatePassage<T extends Record<string, unknown>>(collectionId: string, passageId: string, params: UpdatePassage<T>, options?: CallOptions): Promise<Passage<T>>;
+    /**
+     * Update a passage in a collection.
+     * @param collectionId - The ID of the collection the passage belongs to.
+     * @param documentId - The ID of the document.
+     * @param ids - The IDs of the document passages to update.
+     * @param params - The update passage parameters.
+     * @param [options={}] - The API call options.
+     * @returns The updated passage.
+     */
     updateManyPassages<T extends Record<string, unknown>>(collectionId: string, documentId: string, ids: string[], params: Record<string, unknown>, options?: CallOptions): Promise<Passage<T>[]>;
+    /**
+     * 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.
+     */
     updateCollection(collectionId: string, params: UpdateCollection, options?: CallOptions): Promise<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.
+     */
     getDocument(collectionId: string, documentId: string, options?: CallOptions): Promise<Document>;
+    /**
+     * 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.
+     */
     getCollection(collectionId: string, options?: CallOptions): Promise<Collection>;
+    /**
+     * 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.
+     */
     getPassage<T extends Record<string, unknown>>(collectionId: string, passageId: string, options?: CallOptions & {
         params?: {
             vector: boolean;
         };
     }): Promise<Passage<T>>;
+    /**
+     * Add a custom property to an existing collection.
+     * Custom properties can be used to store additional metadata about the collection or its passages.
+     * The available data types for properties can be found https://weaviate.io/developers/weaviate/config-refs/datatypes.
+     * Note that there are reserved property names:
+     *  ['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.
+     */
     addProperty(collectionId: string, property: Property, options?: CallOptions): Promise<void>;
+    /**
+     * 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.
+     */
     listDocuments(collectionId: string, params?: Find, options?: CallOptions): Promise<List<Document>>;
+    /**
+     * List collections with optional pagination and query.
+     * @param params - Optional find parameters.
+     * @param [options={}] - The API call options.
+     * @returns An array of collections.
+     */
     listCollections(params?: Find, options?: CallOptions): Promise<List<Collection>>;
+    /**
+     * List all passages in a collection with optional pagination and query.
+     * @param collectionId - The ID of the collection to retrieve passages from.
+     * @param params - Optional find parameters.
+     * @param [options={}] - The API call options.
+     * @returns An array of passages.
+     */
     listPassages<T extends Record<string, unknown>>(collectionId: string, params?: FindPassages, options?: CallOptions): Promise<List<Passage<T>>>;
+    /**
+     * List all passages in a document with optional pagination, query, and ordering.
+     * @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.
+     */
     listPassagesInDocument<T extends Record<string, unknown>>(collectionId: string, documentId: string, find?: FindPassages, options?: CallOptions): Promise<List<Passage<T>>>;
+    /**
+     * 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.
+     */
     deleteDocument(collectionId: string, documentId: string, options?: CallOptions): Promise<Document>;
+    /**
+     * Delete multiple documents from a collection.
+     @param collectionId - The ID of the collection to delete the document from.
+     * @param ids - The ID of the collection to delete the document from.
+     * @param [options={}] - The API call options.
+     * @returns IDs of deleted documents and passages.
+     */
     deleteManyDocuments(collectionId: string, ids: string[], options?: CallOptions): Promise<RemoveManyDocumentsResult>;
+    /**
+   * Backup a collection.
+   * @param collectionId - The ID of the collection to backup.
+   * @param params - The backup parameters.
+   * @param [options={}] - The API call options.
+   * @returns A response indicating the success of the operation.
+   */
     backupCollection(collectionId: string, params: Backup, options?: CallOptions): Promise<void>;
+    /**
+     * Restore a collection.
+     * @param params - The restoration parameters.
+     * @param [options={}] - The API call options.
+     * @returns The restored collection information.
+     */
     restoreCollection(params: Restore, options?: CallOptions): Promise<void>;
+    /**
+     * Split a long text into smaller chunks
+     * @param dataToSplit - data to split
+     * @param dataToSplit.text - text content that will be divided
+     * @param dataToSplit.chunkSize - configure the size of each chunk
+     * @param dataToSplit.chunkOverlap - configure chunks overlap value
+     * @param [options={}] - The API call options.
+     * @returns The array of text chunks
+     */
     splitText(dataToSplit: TextSplitterRequest, options?: CallOptions): Promise<TextSplitterResult>;
+    /**
+     * Set the session ID.
+     * @param sessionId - The session ID to set.
+     * @returns The session ID.
+     */
     setSessionId(sessionId: string): string;
 }
 //# sourceMappingURL=Lookup.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Lookup.d.ts","sourceRoot":"","sources":["../../src/Lookup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAgB,IAAI,EAAY,MAAM,cAAc,CAAC;AAIlE,OAAO,EACL,GAAG,EACH,UAAU,EACV,MAAM,EACN,WAAW,EACX,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,QAAQ,EACR,IAAI,EACJ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,QAAQ,EACR,aAAa,EACb,yBAAyB,EACzB,wBAAwB,EACxB,OAAO,EACP,MAAM,EACN,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,aAAa,EAEb,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,SAAS,CAAC;AAIjB,qBAAa,MAAO,SAAQ,IAAI;IAC9B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,mBAAmB,CAAC,CAAS;gBAEzB,MAAM,EAAE,YAAY;YAqBlB,WAAW;IAmBzB,UAAU,CAAC,GAAG,EAAE,OAAO;IAQvB,cAAc,IAAI,OAAO,CAAC,aAAa,CAAC;IAclC,YAAY,CAChB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAgBd,mBAAmB,CACvB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAeV,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAkB1F,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnD,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,EACzB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAiBhB,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,EAC5B,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAeV,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAmBtF,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAkBzI,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,cAAc,CAAC;IAiB1G,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAkBhG,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAmBtF,cAAc,CAClB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAkBd,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnD,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,EACxB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAoBhB,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,EAAE,EACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAqBlB,gBAAgB,CACpB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,gBAAgB,EACxB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,UAAU,CAAC;IAiBhB,WAAW,CACf,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAed,aAAa,CACjB,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,UAAU,CAAC;IAgBhB,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChD,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,WAAW,GAAG;QAAE,MAAM,CAAC,EAAE;YAAE,MAAM,EAAE,OAAO,CAAC;SAAE,CAAC;KAAO,GAC7D,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAqBhB,WAAW,CACf,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,QAAQ,EAClB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAgBV,aAAa,CACjB,YAAY,EAAE,MAAM,EACpB,MAAM,GAAE,IAAS,EACjB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAiBpB,eAAe,CAAC,MAAM,GAAE,IAAS,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAkBxF,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClD,YAAY,EAAE,MAAM,EACpB,MAAM,GAAE,YAAiB,EACzB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAmBtB,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,YAAiB,EACvB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAkBtB,cAAc,CAClB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAiBd,mBAAmB,CACvB,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,MAAM,EAAE,EACb,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,yBAAyB,CAAC;IAiB/B,gBAAgB,CACpB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAeV,iBAAiB,CACrB,MAAM,EAAE,OAAO,EACf,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAkBV,SAAS,CAAC,WAAW,EAAE,mBAAmB,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAczG,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;CAIxC"}
+{"version":3,"file":"Lookup.d.ts","sourceRoot":"","sources":["../../src/Lookup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAgB,IAAI,EAAY,MAAM,cAAc,CAAC;AAIlE,OAAO,EACL,GAAG,EACH,UAAU,EACV,MAAM,EACN,WAAW,EACX,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,QAAQ,EACR,IAAI,EACJ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,QAAQ,EACR,aAAa,EACb,yBAAyB,EACzB,wBAAwB,EACxB,OAAO,EACP,MAAM,EACN,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,aAAa,EAEb,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,SAAS,CAAC;AAIjB,qBAAa,MAAO,SAAQ,IAAI;IAC9B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,mBAAmB,CAAC,CAAS;gBAEzB,MAAM,EAAE,YAAY;YAqBlB,WAAW;IAmBzB,UAAU,CAAC,GAAG,EAAE,OAAO;IAIvB;;;OAGG;IACH,cAAc,IAAI,OAAO,CAAC,aAAa,CAAC;IAOxC;;;;;;OAMG;IACG,YAAY,CAChB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAWpB;;;;OAIG;IACG,mBAAmB,CACvB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;OAKG;IACG,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAWhG;;;;;;OAMG;IACG,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnD,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,EACzB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAWtB;;;;;OAKG;IACG,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,EAC5B,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;OAKG;IACG,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAU5F;;;;;;;OAOG;IAEG,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAW/I;;;;;;OAMG;IACG,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,cAAc,CAAC;IAUhH;;;;;;OAMG;IACG,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAWtG;;;;;;OAMG;IACG,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAW5F;;;;;;;OAOG;IACG,cAAc,CAClB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAUpB;;;;;;;OAOG;IACG,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnD,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,EACxB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAWtB;;;;;;;;OAQG;IACG,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,EAAE,EACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAcxB;;;;;;OAMG;IACG,gBAAgB,CACpB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,gBAAgB,EACxB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,UAAU,CAAC;IAUtB;;;;;;OAMG;IACG,WAAW,CACf,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IASpB;;;;;OAKG;IACG,aAAa,CACjB,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,UAAU,CAAC;IAStB;;;;;;OAMG;IACG,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChD,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,WAAW,GAAG;QAAE,MAAM,CAAC,EAAE;YAAE,MAAM,EAAE,OAAO,CAAC;SAAE,CAAC;KAAO,GAC7D,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAUtB;;;;;;;;;;OAUG;IACG,WAAW,CACf,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,QAAQ,EAClB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;OAMG;IACG,aAAa,CACjB,YAAY,EAAE,MAAM,EACpB,MAAM,GAAE,IAAS,EACjB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAW1B;;;;;OAKG;IACG,eAAe,CAAC,MAAM,GAAE,IAAS,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAW9F;;;;;;OAMG;IACG,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClD,YAAY,EAAE,MAAM,EACpB,MAAM,GAAE,YAAiB,EACzB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAW5B;;;;;;;OAOG;IACG,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,YAAiB,EACvB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAW5B;;;;;;OAMG;IACG,cAAc,CAClB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAUpB;;;;;;OAMG;IACG,mBAAmB,CACvB,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,MAAM,EAAE,EACb,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,yBAAyB,CAAC;IAUrC;;;;;;KAMC;IACK,gBAAgB,CACpB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;OAKG;IACG,iBAAiB,CACrB,MAAM,EAAE,OAAO,EACf,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;;;OAQG;IACG,SAAS,CAAC,WAAW,EAAE,mBAAmB,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IASzG;;;;OAIG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;CAIxC"}

package/dist/types/types.d.ts

@@ -5,79 +5,279 @@ export type CallOptions = {
     signal?: AbortSignal;
 };
 export type LookupConfig = {
+    /**
+     * token
+     */
     token: Token;
+    /**
+     * Url of OneReach service discovery api
+     */
     discoveryUrl?: string;
+    /**
+     * Account ID for cross-account requests (super admin only)
+     */
     accountId?: string;
+    /**
+     * Url of OneReach lookup api
+     */
     serviceUrl?: string;
+    /**
+     * Feature name, default: 'master'
+     */
     feature?: string;
+    /**
+     * Flow SessionID (Used for correct tracking)
+     */
     sessionId?: string;
+    /**
+     * Flow beginningSessionId (Used for correct tracking)
+     */
     beginningSessionId?: string;
 };
+/**
+ * Document creation parameters
+ */
 export type LoadDocument = {
+    /**
+     * Document name
+     */
     name: string;
+    /**
+     * Document URL
+     */
     url?: string;
+    /**
+     * Document description
+     */
     description?: string;
+    /**
+     * Default custom properties for document passages.
+     * Note that these properties should be listed in collection properties
+     */
     defaultProperties: Record<string, unknown>;
 };
+/**
+ * Documents crawl creation parameters
+ */
 export type CrawlDocuments = {
+    /**
+     * Document URL
+     */
     url: string;
+    /**
+     * Searchable prefix
+     */
     prefix: string;
+    /**
+     * Limit for documents creation
+     */
     limit: number;
+    /**
+     * Default custom properties for documents.
+     * Note that these properties should be listed in collection properties
+     */
     defaultProperties: Record<string, unknown>;
 };
 export type Property = {
+    /**
+     * Property name. e.g. `nameOfTheAuthor`
+     */
     name: string;
+    /**
+     * Property type. See https://weaviate.io/developers/weaviate/config-refs/schema#datatypes for the available types
+     */
     dataType: string;
+    /**
+     * Property description
+     */
     description?: string;
+    /**
+     * Nested properties only for object dataType properties
+     */
     nestedProperties?: Property[];
+    /**
+     * custom property vectorization, use OpenAI API to vectorize the property
+     */
     vectorize?: boolean;
 };
+/**
+ * Search parameters
+ */
 export type Search = {
+    /**
+     * Search query
+     */
     query: string;
+    /**
+     * Limit the number of results.
+     */
     limit?: number;
+    /**
+     * Offset for the results.
+     */
     offset?: number;
+    /**
+     * Weaviate where filter. See https://weaviate.io/developers/weaviate/api/graphql/filters
+     */
     where?: Record<string, unknown>;
+    /**
+     * Array of the custom properties to select.
+     */
     select?: string[];
+    /**
+     * Filter out passages that are further than maxDistance from the question or context by cosine metric.
+     * Default: 0
+     * Range: 0 - 1
+     */
     maxDistance?: number;
+    /**
+     * Custom vector for search, in this case embeddingProvider and embeddingModel are ignored
+     */
     vector?: number[];
+    /**
+     * Alpha parameter for hybrid search to balance between vector and keyword search.
+     * 0.0 means keyword-only search, 1.0 means vector-only search.
+     * Default: 1
+     * Range: 0 - 1
+     */
     alpha?: number;
 };
 export type MessageRole = 'user' | 'assistant';
 export type AskMode = 'conversation' | 'ask';
+/**
+ * Message data for completion request
+ */
 export type CompletionRequestMessage = {
+    /**
+     * Role of the message sender (either "user" or "assistant")
+     */
     role: MessageRole;
+    /**
+     * Content of the message
+     */
     content: string;
 };
+/**
+ * Ask question parameters
+ */
 export type Ask = {
+    /**
+     * Question to ask
+     */
     question: string;
+    /**
+     * Previous chat messages
+     * Default: []
+     */
     messages?: CompletionRequestMessage[];
+    /**
+     * Limit the number of results.
+     * Default: 5
+     * Range: 1 - 100
+     */
     limit?: number;
+    /**
+     * Offset for the results.
+     */
     offset?: number;
+    /**
+     * Weaviate where filter. See https://weaviate.io/developers/weaviate/api/graphql/filters
+     * Optional
+     */
     where?: Record<string, unknown>;
+    /**
+     * Array of the custom properties to select.
+     * Optional
+     */
     select?: string[];
+    /**
+     * Question mode.
+     * Default: 'conversation'
+     * Values: 'conversation', 'ask'
+     */
     mode?: AskMode;
+    /**
+     * A summarization instruction used to generate correct answer.
+     * Maximum Length: 1000 characters
+     * Optional
+     */
     answerInstruction?: string | null;
+    /**
+     * A summarization instruction used to generate correct search query.
+     * Maximum Length: 1000 characters
+     * Optional
+     */
     questionInstruction?: string | null;
+    /**
+     * What sampling temperature to use.
+     * Default: 1
+     * Range: 0 - 2
+     */
     temperature?: number;
+    /**
+     * Maximum output length from the LLM
+     * Default: 1024
+     * Range: 128 - 2048
+     */
     maxTokens?: number;
+    /**
+     * Positive values penalize new tokens based on their existing frequency in the text so far.
+     * Default: 0
+     * Range: -2 - 2
+     */
     frequencyPenalty?: number;
+    /**
+     * Penalize new tokens based on whether they appear in the text so far.
+     * Default: 0
+     * Range: -2 - 2
+     */
     presencePenalty?: number;
+    /**
+     * Filter out passages that are further than maxDistance from the question or context by cosine metric.
+     * Default: 0
+     * Range: 0 - 1
+     */
     maxDistance?: number;
+    /**
+     * Prompt provider (Optional)
+     * Maximum length: 64
+     */
     promptProvider?: string;
+    /**
+     * Large language model name (Optional)
+     * Maximum length: 64
+     */
     promptModel?: string;
+    /**
+     * Token name for the prompt
+    */
+    promptTokenName?: string;
+    /**
+     * Prompt guardrail identifier.
+     */
+    promptGuardrailIdentifier?: string;
 };
+/**
+ * DocumentStatus represents the loading status of a document.
+ */
 export declare enum DocumentStatus {
     NEW = "NEW",
     LOADING = "LOADING",
     READY = "READY",
     ERROR = "ERROR"
 }
+/**
+ * BackupStatus represents the backup status of a collection.
+ */
 export declare enum BackupStatus {
     BACKUP = "BACKUP",
     RESTORE = "RESTORE",
     READY = "READY",
     ERROR = "ERROR"
 }
+/**
+ * CollectionType represents the type of a collection.
+ */
 export declare enum CollectionType {
     DEFAULT = "DEFAULT",
     QNA_V1 = "QNA_V1",
@@ -85,143 +285,547 @@ export declare enum CollectionType {
     CUSTOM = "CUSTOM"
 }
 export type DocumentProperty = {
+    /**
+     * Property name. e.g. `nameOfTheAuthor`
+     */
     name: string;
+    /**
+     * Property value
+     */
     value?: unknown;
 };
+/**
+ * Document represents a document object.
+ */
 export type Document = {
+    /**
+     * Document ID
+     */
     id: string;
+    /**
+     * Collection ID
+     */
     collection: string;
+    /**
+     * Document name
+     */
     name: string;
+    /**
+     * Document description
+     */
     description: string;
+    /**
+     * List of document properties
+     */
     properties?: DocumentProperty[];
+    /**
+     * Document loading status or error message
+     */
     status: DocumentStatus | string;
+    /**
+     * Creation Date
+     */
     createdAt: string;
+    /**
+     * Updating Date
+     */
     updatedAt: string;
+    /**
+     * Number of passages in the document.
+     */
     countPassages?: number;
+    /**
+     * The URL of the source this document is downloaded from if provided.
+     */
     sourceUrl?: string;
 };
+/**
+ * Collection represents a collection object.
+ */
 export type Collection = {
+    /**
+     * Collection ID
+     */
     id: string;
+    /**
+     * Account ID
+     */
     accountId: string;
+    /**
+     * Collection name
+     * Can start only with a letter.
+     * Minimum length: 5, Maximum length: 100
+     */
     name: string;
+    /**
+     * Collection description (Optional)
+     * Minimum length: 3, Maximum length: 500
+     */
     description?: string;
+    /**
+     * Collection backup/restore status
+     */
     status?: BackupStatus | string;
+    /**
+     * A collection thumbnail image URL (Optional)
+     * Minimum length: 3, Maximum length: 2048
+     */
     imageUrl?: string;
+    /**
+     * A summarization instruction used to generate a correct answer (Optional)
+     * Maximum length: 1000
+     */
     answerInstruction?: string | null;
+    /**
+     * A summarization instruction used to generate a correct search query (Optional)
+     * Maximum length: 1000
+     */
     questionInstruction?: string | null;
+    /**
+     * A summarization instruction used to generate a correct first message (Optional)
+     * Maximum length: 1000
+     */
     greetingInstruction?: string | null;
+    /**
+     * Custom properties (Optional)
+     * Type: Array<Property>
+     */
     properties?: Property[];
+    /**
+     * Creation Date
+     */
     createdAt: string | Date;
+    /**
+     * Updating Date
+     */
     updatedAt: string | Date;
+    /**
+     * What sampling temperature to use.
+     * Minimum value: 0, Maximum value: 2
+     */
     temperature?: number;
+    /**
+     * Max output length from the LLM
+     * Minimum value: 128, Maximum value: 2048
+     */
     maxTokens?: number;
+    /**
+     * Max number of passages returned in result
+     * Minimum value: 1
+     */
     limit?: number;
+    /**
+     * Hybrid search
+     * Minimum value: 0
+     * Maximum value: 1
+     */
     alpha?: number;
+    /**
+     * Positive values penalize new tokens based on their existing frequency in the text so far.
+     * Minimum value: -2, Maximum value: 2
+     */
     frequencyPenalty?: number;
+    /**
+     * Penalize new tokens based on whether they appear in the text so far.
+     * Minimum value: -2, Maximum value: 2
+     */
     presencePenalty?: number;
+    /**
+     * Filter out passages that are further then maxDistance from the question or context by cosine metric.
+     * Minimum value: 0, Maximum value: 1
+     */
     maxDistance?: number;
+    /**
+     * @deprecated Use `promptModel` instead.
+     */
     modelName?: string;
+    /**
+     * Ai token name from account settings (Optional)
+     */
     promptTokenName?: string;
+    /**
+     * Prompt provider.
+     */
     promptProvider?: string;
+    /**
+     * Large language model name.
+     */
     promptModel?: string;
+    /**
+     * Prompt guardrail identifier.
+     */
+    promptGuardrailIdentifier?: string;
+    /**
+     * Ai token name from account settings (Optional)
+     */
     embeddingTokenName?: string;
+    /**
+     * Embedding provider.
+     */
     embeddingProvider?: string;
+    /**
+     * Embedding model name.
+     */
     embeddingModel?: string;
+    /**
+     * Embedding guardrail identifier.
+     */
+    embeddingGuardrailIdentifier?: string;
+    /**
+     * Number of passages in the collection.
+     */
     countPassages?: number;
+    /**
+     * Number of documents in the collection.
+     */
     countDocs?: number;
+    /**
+     * Collection type, it will be used for specific document loading post-processing. (Optional)
+     */
     type?: CollectionType;
+    /**
+     * Top-p (nucleus): The cumulative probability cutoff for token selection.
+     * Lower values mean sampling from a smaller, more top-weighted nucleus.
+     */
     topP?: number;
+    /**
+      * Top-k: Sample from the k most likely next tokens at each step.
+      * Lower k focuses on higher probability tokens.
+      */
     topK?: number;
 };
+/**
+ * SearchResult represents a document found as a result of a search query.
+ */
 export type SearchResult = {
+    /**
+     * Found passage ID
+     */
     id: string;
+    /**
+     * Cosine distance between search query and result.
+     */
     distance: string;
+    /**
+     * Found passage content.
+     */
     content: string;
+    /**
+     * SourceUrl
+     */
     sourceUrl: string;
+    /**
+     * Found passage metadata.
+     */
     loaderMetadata: Record<string, unknown>;
+    /**
+     * Found passage metadata.
+     */
     document: {
         id: string;
         name: string;
     };
+    /**
+     * Used properties in search.
+     */
     select: string[];
 };
+/**
+ * AskResults represents the response from an ask question query.
+ */
 export type AskResults = {
+    /**
+     * Generated answer from the chat completion.
+     */
     result: CompletionRequestMessage;
+    /**
+     * Search result for the input question.
+     */
     searchResult: SearchResult;
+    /**
+     * Used properties in search.
+     */
     select: string[];
 };
+/**
+ * UpdateDocument parameters
+ */
 export type UpdateDocument = {
+    /**
+     * Document name
+     */
     name?: string;
+    /**
+     * Document description
+     */
     description?: string;
+    /**
+     * Document status or loading error message
+     */
     status?: DocumentStatus | string;
+    /**
+     * Custom properties for document.
+     * Note that these properties should be listed in document properties
+     */
     properties?: DocumentProperty[];
 };
+/**
+ * CreateCollection parameters
+ */
 export type CreateCollection = UpdateCollection & {
+    /**
+     * Custom properties (Optional)
+     * Type: Array<Property>
+     */
     properties?: Property[];
+    /**
+     * Collection type, it will be used for specific document loading post-processing. (Optional)
+     */
     type?: CollectionType;
+    /**
+     * Prompt provider (Optional)
+     * Maximum length: 64
+     */
     embeddingProvider?: string;
+    /**
+     * Prompt provider (Optional)
+     * Maximum length: 64
+     */
     embeddingModel?: string;
 };
+/**
+ * UpdateCollection parameters
+ */
 export type UpdateCollection = {
+    /**
+     * Collection name
+     * Can start only with a letter.
+     * Minimum length: 5, Maximum length: 100
+     */
     name?: string;
+    /**
+     * Collection description (Optional)
+     * Minimum length: 3, Maximum length: 500
+     */
     description?: string;
+    /**
+     * A collection thumbnail image URL (Optional)
+     * Minimum length: 3, Maximum length: 2048
+     */
     imageUrl?: string;
+    /**
+     * A summarization instruction used to generate a correct answer (Optional)
+     * Maximum length: 1000
+     */
     answerInstruction?: string;
+    /**
+     * A summarization instruction used to generate a correct search query (Optional)
+     * Maximum length: 1000
+     */
     questionInstruction?: string;
+    /**
+     * A summarization instruction used to generate a correct first message (Optional)
+     * Maximum length: 1000
+     */
     greetingInstruction?: string;
+    /**
+     * What sampling temperature to use (Optional)
+     * Default value: 1, Range: [0, 2]
+     */
     temperature?: number;
+    /**
+     * Max output length from the LLM (Optional)
+     * Range: [128, 2048]
+     */
     maxTokens?: number;
+    /**
+     * Positive values penalize new tokens based on their existing frequency in the text so far (Optional)
+     * Range: [-2, 2]
+     */
     frequencyPenalty?: number;
+    /**
+     * Penalize new tokens based on whether they appear in the text so far (Optional)
+     * Range: [-2, 2]
+     */
     presencePenalty?: number;
+    /**
+     * Filter out passages that are further then maxDistance from the question or context by
+     * cosine metric (Optional)
+     * Range: [0, 1]
+     */
     maxDistance?: number;
+    /**
+     * Large language model name (Optional)
+     * Maximum length: 64
+     * @deprecated Use `promptModel` instead.
+     */
     modelName?: string;
+    /**
+     * Ai token name from account settings (Optional)
+     */
     promptTokenName?: string;
+    /**
+     * Prompt guardrail identifier.
+     */
+    promptGuardrailIdentifier?: string;
+    /**
+     * Prompt provider (Optional)
+     * Maximum length: 64
+     */
     promptProvider?: string;
+    /**
+     * Large language model name (Optional)
+     * Maximum length: 64
+     */
     promptModel?: string;
+    /**
+     * Ai token name from account settings (Optional)
+     */
     embeddingTokenName?: string;
+    /**
+     * Embedding guardrail identifier.
+     */
+    embeddingGuardrailIdentifier?: string;
+    /**
+     * Top-p (nucleus): The cumulative probability cutoff for token selection.
+     * Lower values mean sampling from a smaller, more top-weighted nucleus.
+     */
     topP?: number;
+    /**
+     * Top-k: Sample from the k most likely next tokens at each step.
+     * Lower k focuses on higher probability tokens.
+     */
     topK?: number;
 };
+/**
+ * Find parameters
+ */
 export type Find = Partial<PaginationOptions> & Partial<OrderOptions> & {
+    /**
+     * Search query
+    */
     query?: string;
+    /**
+     * Search mode: bm25 for full-text search and vector for vector similarity search.
+     */
     mode?: SearchMode;
 };
+/**
+ * Find passages parameters
+ */
 export type FindPassages = Find & {
+    /**
+     * Weaviate where filter. See https://weaviate.io/developers/weaviate/api/graphql/filters
+     */
     where?: Record<string, unknown>;
 };
 type TypedPassageProperties = {
+    /**
+     * Content of the default collection passage
+     */
     content: string;
 } | {
+    /**
+     * question of the QnA collection passage
+     */
     question: string;
+    /**
+     * answer of the QnA collection passage
+     */
     answer: string;
 } & {
+    /**
+     * Custom vector for search, in this case embeddingProvider and embeddingModel are ignored
+     */
     vector?: number[];
 };
+/**
+ * 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
+     */
     documentId: string;
+    /**
+     * Custom loader metadata. Non filterable property
+     */
     loaderMetadata?: Record<string, unknown>;
 } & T;
+/**
+ * Passage represents a passage object.
+ */
 export type Passage<T extends Record<string, unknown> = Record<string, unknown>> = TypedPassageProperties & {
+    /**
+     * Passage ID
+     */
     id: string;
+    /**
+     * Creation Date
+     */
     createdAt: string;
+    /**
+     * Updating Date
+     */
     updatedAt: string;
 } & T;
+/**
+ * Update passage parameters
+ */
 export type UpdatePassage<T extends Record<string, unknown> = Record<string, unknown>> = TypedPassageProperties & T;
+/**
+ * Represents a deleted passage.
+ */
 export type DeletedPassage = {
+    /**
+     * The ID of the deleted passage.
+     */
     id: string;
 };
+/**
+ * Represents a list if ids of  deleted passages.
+ */
 export type RemoveManyPassagesResult = {
+    /**
+     * The IDs of the deleted passages.
+     */
     removedIds: string[];
 };
+/**
+ * Backup parameters
+ */
 export type Backup = {
+    /**
+     * Prefix in Files the backup files to put into
+     * Minimum length: 3, Maximum length: 500
+     */
     prefix: string;
 };
+/**
+ * Restore parameters
+ */
 export type Restore = {
+    /**
+     * Prefix in Files the backup files to put into
+     * Minimum length: 3, Maximum length: 500
+     */
     key: string;
+    /**
+     * Does file has public privacy in files
+     */
     isPublic: boolean;
 };
+/**
+ * Result of removing multiple documents
+ */
 export type RemoveManyDocumentsResult = {
+    /**
+     * IDs of removed documents
+     */
     removedDocumentsIds: string[];
+    /**
+     * IDs of removed passages
+     */
     removedPassagesIds: string[];
 };
 export type ProvidersList = {

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;IAKjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,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,MAAM,GAAG;IAInB,KAAK,EAAE,MAAM,CAAC;IAKd,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,MAAM,CAAC,EAAE,MAAM,CAAC;IAKhB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKhC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAOlB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAQlB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,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;IAKf,MAAM,CAAC,EAAE,MAAM,CAAC;IAMhB,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;IAMrB,cAAc,CAAC,EAAE,MAAM,CAAC;IAMxB,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;IACf,KAAK,UAAU;CAChB;AAKD,oBAAY,cAAc;IACxB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,gBAAgB,GAAG;IAI7B,IAAI,EAAE,MAAM,CAAC;IAKb,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,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,GAAG,MAAM,CAAC;IAM/B,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,KAAK,CAAC,EAAE,MAAM,CAAC;IAOf,KAAK,CAAC,EAAE,MAAM,CAAC;IAMf,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAM1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAMzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,eAAe,CAAC,EAAE,MAAM,CAAC;IAKzB,cAAc,CAAC,EAAE,MAAM,CAAC;IAKxB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAK5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAK3B,cAAc,CAAC,EAAE,MAAM,CAAC;IAKxB,aAAa,CAAC,EAAE,MAAM,CAAC;IAKvB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,IAAI,CAAC,EAAE,cAAc,CAAC;IAMtB,IAAI,CAAC,EAAE,MAAM,CAAC;IAMd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,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,IAAI,CAAC,EAAE,MAAM,CAAC;IAId,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;IAMjC,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACjC,CAAC;AAMF,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG;IAMhD,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;IAKxB,IAAI,CAAC,EAAE,cAAc,CAAC;IAMtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAM3B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAKF,MAAM,MAAM,gBAAgB,GAAG;IAM7B,IAAI,CAAC,EAAE,MAAM,CAAC;IAMd,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;IAOrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,eAAe,CAAC,EAAE,MAAM,CAAC;IAKzB,cAAc,CAAC,EAAE,MAAM,CAAC;IAMxB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAM5B,IAAI,CAAC,EAAE,MAAM,CAAC;IAMd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,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,GAAG;IAIF,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,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;IAKZ,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAKF,MAAM,MAAM,yBAAyB,GAAG;IAItC,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAI9B,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;KAC7B,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAIhC,IAAI,EAAE,MAAM,CAAC;IAIb,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC,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;IACzB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,WAAW,CAAC;AAC/C,MAAM,MAAM,OAAO,GAAG,cAAc,GAAG,KAAK,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;MAEE;IACF,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC;IAEhC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IAE/B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;QAGI;IACJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAExC;;OAEG;IACH,QAAQ,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAEF;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,MAAM,EAAE,wBAAwB,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAGF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;IAEjC;;;OAGG;IACH,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACjC,CAAC;AAGF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG;IAEhD;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG;IACtE;;MAEE;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG;IACF;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG;IACF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,sBAAsB,GAAG;IAChH;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1C,GAAG,CAAC,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,sBAAsB,GAAG;IAC1G;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,GAAG,CAAC,CAAC;AAGN;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,sBAAsB,GAAG,CAAC,CAAC;AAEpH;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAGF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B;;OAEG;IACH,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;KAC7B,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAIhC,IAAI,EAAE,MAAM,CAAC;IAIb,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/lookup",
-  "version": "1.23.1",
+  "version": "1.24.0-beta.4074.0",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -30,6 +30,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "7d3b49250a670964dfe9e8e50e95417761c5473f"
+  }
 }

package/src/types.ts

@@ -294,6 +294,16 @@ export type Ask = {
    * Maximum length: 64
    */
   promptModel?: string;
+
+  /**
+   * Token name for the prompt
+  */
+  promptTokenName?: string;
+
+  /**
+   * Prompt guardrail identifier.
+   */
+  promptGuardrailIdentifier?: string;
 };
 
 /**
@@ -528,6 +538,11 @@ export type Collection = {
    */
   promptModel?: string;
 
+  /**
+   * Prompt guardrail identifier.
+   */
+  promptGuardrailIdentifier?: string;
+
   /**
    * Ai token name from account settings (Optional)
    */
@@ -543,6 +558,11 @@ export type Collection = {
    */
   embeddingModel?: string;
 
+  /**
+   * Embedding guardrail identifier.
+   */
+  embeddingGuardrailIdentifier?: string;
+
   /**
    * Number of passages in the collection.
    */
@@ -773,6 +793,12 @@ export type UpdateCollection = {
    * Ai token name from account settings (Optional)
    */
   promptTokenName?: string;
+
+  /**
+   * Prompt guardrail identifier.
+   */
+  promptGuardrailIdentifier?: string;
+
   /**
    * Prompt provider (Optional)
    * Maximum length: 64
@@ -790,6 +816,11 @@ export type UpdateCollection = {
    */
   embeddingTokenName?: string;
 
+  /**
+   * Embedding guardrail identifier.
+   */
+  embeddingGuardrailIdentifier?: string;
+
   /**
    * Top-p (nucleus): The cumulative probability cutoff for token selection.
    * Lower values mean sampling from a smaller, more top-weighted nucleus.