@ontos-ai/knowhere-sdk 0.9.0 → 0.10.0

package/README.md

@@ -252,16 +252,22 @@ const updateJob = await client.jobs.create({
   documentId,
 });
 
-const documents = await client.documents.list({ namespace: 'support-center' });
+const documents = await client.documents.list({
+  namespace: 'support-center',
+  page: 1,
+  pageSize: 50,
+});
 const document = await client.documents.get(documentId);
 const chunks = await client.documents.listChunks(documentId, {
   page: 1,
   pageSize: 50,
-  chunkType: 'text',
+  chunkType: 'image',
+  includeAssetUrls: true,
 });
 const archived = await client.documents.archive(documentId);
 
 console.log(documents.documents.length);
+console.log(documents.pagination.totalPages);
 console.log(document.status);
 console.log(chunks.pagination.total);
 if (chunks.chunks[0]) {
@@ -269,6 +275,7 @@ if (chunks.chunks[0]) {
     includeAssetUrls: true,
   });
   console.log(chunk.chunk.content);
+  console.log(chunk.chunk.assetUrl);
 }
 console.log(archived.status);
 ```

package/dist/index.d.mts

@@ -799,6 +799,30 @@ interface Document {
     /** Archive timestamp, when archived */
     archivedAt?: Date;
 }
+/**
+ * Pagination metadata returned by document list endpoints.
+ */
+interface DocumentListPagination {
+    /** Current page number */
+    page: number;
+    /** Number of items requested per page */
+    pageSize: number;
+    /** Total matching documents */
+    total: number;
+    /** Total number of pages */
+    totalPages: number;
+}
+/**
+ * Query parameters for GET /v1/documents.
+ */
+interface DocumentListParams {
+    /** Retrieval namespace */
+    namespace?: string;
+    /** Page number (default: 1) */
+    page?: number;
+    /** Items per page (default: 50, maximum: 200) */
+    pageSize?: number;
+}
 /**
  * Response from GET /v1/documents.
  */
@@ -807,6 +831,8 @@ interface DocumentListResponse {
     namespace: string;
     /** Documents visible in the namespace */
     documents: Document[];
+    /** Pagination metadata */
+    pagination: DocumentListPagination;
 }
 /**
  * Document chunk types supported by document chunk endpoints.
@@ -835,14 +861,14 @@ interface DocumentChunkListParams {
     pageSize?: number;
     /** Optional chunk type filter */
     chunkType?: DocumentChunkType;
-    /** Generate asset URLs for media chunks (default: false) */
+    /** Set true to include 7-day asset URLs for media chunks */
     includeAssetUrls?: boolean;
 }
 /**
  * Query parameters for GET /v1/documents/{document_id}/chunks/{document_chunk_id}.
  */
 interface DocumentChunkGetParams {
-    /** Generate asset URLs for media chunks (default: false) */
+    /** Set true to include 7-day asset URLs for media chunks */
     includeAssetUrls?: boolean;
 }
 /**
@@ -869,7 +895,7 @@ interface DocumentChunk {
     sortOrder: number;
     /** Chunk metadata returned by the API */
     metadata: Record<string, unknown>;
-    /** Generated asset URL when requested and available */
+    /** 7-day asset URL for media chunks when available */
     assetUrl?: string | null;
     /** Chunk creation timestamp */
     createdAt?: Date;
@@ -914,9 +940,7 @@ declare class Documents extends BaseResource {
     /**
      * List canonical documents in a namespace.
      */
-    list(params?: {
-        namespace?: string;
-    }): Promise<DocumentListResponse>;
+    list(params?: DocumentListParams): Promise<DocumentListResponse>;
     /**
      * Get one canonical document by ID.
      */
@@ -933,6 +957,8 @@ declare class Documents extends BaseResource {
      * Archive one canonical document by ID.
      */
     archive(documentId: string): Promise<Document>;
+    private createDocumentListRequestConfig;
+    private normalizeDocumentListResponse;
     private createChunkListRequestConfig;
     private createChunkGetRequestConfig;
 }
@@ -1358,4 +1384,4 @@ declare class JobFailedError extends KnowhereError {
     constructor(message: string, code: string, jobResult: JobResult);
 }
 
-export { APIError, type AuthTokenProvider, AuthenticationError, BadRequestError, type BaseChunk, ChecksumError, type Chunk, ConflictError, type CreateJobParams, type DocType, type Document, type DocumentChunk, type DocumentChunkGetParams, type DocumentChunkListParams, type DocumentChunkListResponse, type DocumentChunkPagination, type DocumentChunkResponse, type DocumentChunkType, type DocumentListResponse, type DocumentMetadata, Documents, type FileIndex, GatewayTimeoutError, type ImageChunk, InternalServerError, InvalidStateError, type Job, type JobError, JobFailedError, type JobResult, type JobStatus, Jobs, Knowhere, KnowhereError, type KnowhereOptions, Knowledge, type KnowledgeAsyncJobStatusResponse, type KnowledgeAsyncParseParams, type KnowledgeAsyncParseResponse, type KnowledgeCacheDocumentParams, type KnowledgeCacheJobResultParams, type KnowledgeChunkType, type KnowledgeDocumentReference, type KnowledgeGrepMatch, type KnowledgeGrepParams, type KnowledgeGrepResponse, type KnowledgeOutline, type KnowledgeParseParams, type KnowledgeReadChunk, type KnowledgeReadParams, type KnowledgeReadResponse, type KnowledgeSearchParams, type KnowledgeSearchReference, type KnowledgeSearchResponse, type KnowledgeSearchResult, type KnowledgeSection, type KnowledgeStartupRecoveryResponse, type LoadOptions, type LocalKnowledgeDocument, type LocalKnowledgeParseResponse, LocalKnowledgeStore, type Manifest, NetworkError, NotFoundError, type ParseParams, type ParseResult, type ParsingModel, type ParsingParams, PaymentRequiredError, PermissionDeniedError, type PollProgress, PollingTimeoutError, RateLimitError, Retrieval, type RetrievalChannel, type RetrievalFilterMode, type RetrievalQueryParams, type RetrievalQueryResponse, type RetrievalReferencedChunk, type RetrievalResult, type RetrievalSectionExclusion, type RetrievalSource, ServiceUnavailableError, type Statistics, type TableChunk, type TextChunk, TimeoutError, type UploadParams, type UploadProgress, VERSION, ValidationError, type WaitOptions, type WebhookConfig, Knowhere as default };
+export { APIError, type AuthTokenProvider, AuthenticationError, BadRequestError, type BaseChunk, ChecksumError, type Chunk, ConflictError, type CreateJobParams, type DocType, type Document, type DocumentChunk, type DocumentChunkGetParams, type DocumentChunkListParams, type DocumentChunkListResponse, type DocumentChunkPagination, type DocumentChunkResponse, type DocumentChunkType, type DocumentListPagination, type DocumentListParams, type DocumentListResponse, type DocumentMetadata, Documents, type FileIndex, GatewayTimeoutError, type ImageChunk, InternalServerError, InvalidStateError, type Job, type JobError, JobFailedError, type JobResult, type JobStatus, Jobs, Knowhere, KnowhereError, type KnowhereOptions, Knowledge, type KnowledgeAsyncJobStatusResponse, type KnowledgeAsyncParseParams, type KnowledgeAsyncParseResponse, type KnowledgeCacheDocumentParams, type KnowledgeCacheJobResultParams, type KnowledgeChunkType, type KnowledgeDocumentReference, type KnowledgeGrepMatch, type KnowledgeGrepParams, type KnowledgeGrepResponse, type KnowledgeOutline, type KnowledgeParseParams, type KnowledgeReadChunk, type KnowledgeReadParams, type KnowledgeReadResponse, type KnowledgeSearchParams, type KnowledgeSearchReference, type KnowledgeSearchResponse, type KnowledgeSearchResult, type KnowledgeSection, type KnowledgeStartupRecoveryResponse, type LoadOptions, type LocalKnowledgeDocument, type LocalKnowledgeParseResponse, LocalKnowledgeStore, type Manifest, NetworkError, NotFoundError, type ParseParams, type ParseResult, type ParsingModel, type ParsingParams, PaymentRequiredError, PermissionDeniedError, type PollProgress, PollingTimeoutError, RateLimitError, Retrieval, type RetrievalChannel, type RetrievalFilterMode, type RetrievalQueryParams, type RetrievalQueryResponse, type RetrievalReferencedChunk, type RetrievalResult, type RetrievalSectionExclusion, type RetrievalSource, ServiceUnavailableError, type Statistics, type TableChunk, type TextChunk, TimeoutError, type UploadParams, type UploadProgress, VERSION, ValidationError, type WaitOptions, type WebhookConfig, Knowhere as default };

package/dist/index.d.ts

@@ -799,6 +799,30 @@ interface Document {
     /** Archive timestamp, when archived */
     archivedAt?: Date;
 }
+/**
+ * Pagination metadata returned by document list endpoints.
+ */
+interface DocumentListPagination {
+    /** Current page number */
+    page: number;
+    /** Number of items requested per page */
+    pageSize: number;
+    /** Total matching documents */
+    total: number;
+    /** Total number of pages */
+    totalPages: number;
+}
+/**
+ * Query parameters for GET /v1/documents.
+ */
+interface DocumentListParams {
+    /** Retrieval namespace */
+    namespace?: string;
+    /** Page number (default: 1) */
+    page?: number;
+    /** Items per page (default: 50, maximum: 200) */
+    pageSize?: number;
+}
 /**
  * Response from GET /v1/documents.
  */
@@ -807,6 +831,8 @@ interface DocumentListResponse {
     namespace: string;
     /** Documents visible in the namespace */
     documents: Document[];
+    /** Pagination metadata */
+    pagination: DocumentListPagination;
 }
 /**
  * Document chunk types supported by document chunk endpoints.
@@ -835,14 +861,14 @@ interface DocumentChunkListParams {
     pageSize?: number;
     /** Optional chunk type filter */
     chunkType?: DocumentChunkType;
-    /** Generate asset URLs for media chunks (default: false) */
+    /** Set true to include 7-day asset URLs for media chunks */
     includeAssetUrls?: boolean;
 }
 /**
  * Query parameters for GET /v1/documents/{document_id}/chunks/{document_chunk_id}.
  */
 interface DocumentChunkGetParams {
-    /** Generate asset URLs for media chunks (default: false) */
+    /** Set true to include 7-day asset URLs for media chunks */
     includeAssetUrls?: boolean;
 }
 /**
@@ -869,7 +895,7 @@ interface DocumentChunk {
     sortOrder: number;
     /** Chunk metadata returned by the API */
     metadata: Record<string, unknown>;
-    /** Generated asset URL when requested and available */
+    /** 7-day asset URL for media chunks when available */
     assetUrl?: string | null;
     /** Chunk creation timestamp */
     createdAt?: Date;
@@ -914,9 +940,7 @@ declare class Documents extends BaseResource {
     /**
      * List canonical documents in a namespace.
      */
-    list(params?: {
-        namespace?: string;
-    }): Promise<DocumentListResponse>;
+    list(params?: DocumentListParams): Promise<DocumentListResponse>;
     /**
      * Get one canonical document by ID.
      */
@@ -933,6 +957,8 @@ declare class Documents extends BaseResource {
      * Archive one canonical document by ID.
      */
     archive(documentId: string): Promise<Document>;
+    private createDocumentListRequestConfig;
+    private normalizeDocumentListResponse;
     private createChunkListRequestConfig;
     private createChunkGetRequestConfig;
 }
@@ -1358,4 +1384,4 @@ declare class JobFailedError extends KnowhereError {
     constructor(message: string, code: string, jobResult: JobResult);
 }
 
-export { APIError, type AuthTokenProvider, AuthenticationError, BadRequestError, type BaseChunk, ChecksumError, type Chunk, ConflictError, type CreateJobParams, type DocType, type Document, type DocumentChunk, type DocumentChunkGetParams, type DocumentChunkListParams, type DocumentChunkListResponse, type DocumentChunkPagination, type DocumentChunkResponse, type DocumentChunkType, type DocumentListResponse, type DocumentMetadata, Documents, type FileIndex, GatewayTimeoutError, type ImageChunk, InternalServerError, InvalidStateError, type Job, type JobError, JobFailedError, type JobResult, type JobStatus, Jobs, Knowhere, KnowhereError, type KnowhereOptions, Knowledge, type KnowledgeAsyncJobStatusResponse, type KnowledgeAsyncParseParams, type KnowledgeAsyncParseResponse, type KnowledgeCacheDocumentParams, type KnowledgeCacheJobResultParams, type KnowledgeChunkType, type KnowledgeDocumentReference, type KnowledgeGrepMatch, type KnowledgeGrepParams, type KnowledgeGrepResponse, type KnowledgeOutline, type KnowledgeParseParams, type KnowledgeReadChunk, type KnowledgeReadParams, type KnowledgeReadResponse, type KnowledgeSearchParams, type KnowledgeSearchReference, type KnowledgeSearchResponse, type KnowledgeSearchResult, type KnowledgeSection, type KnowledgeStartupRecoveryResponse, type LoadOptions, type LocalKnowledgeDocument, type LocalKnowledgeParseResponse, LocalKnowledgeStore, type Manifest, NetworkError, NotFoundError, type ParseParams, type ParseResult, type ParsingModel, type ParsingParams, PaymentRequiredError, PermissionDeniedError, type PollProgress, PollingTimeoutError, RateLimitError, Retrieval, type RetrievalChannel, type RetrievalFilterMode, type RetrievalQueryParams, type RetrievalQueryResponse, type RetrievalReferencedChunk, type RetrievalResult, type RetrievalSectionExclusion, type RetrievalSource, ServiceUnavailableError, type Statistics, type TableChunk, type TextChunk, TimeoutError, type UploadParams, type UploadProgress, VERSION, ValidationError, type WaitOptions, type WebhookConfig, Knowhere as default };
+export { APIError, type AuthTokenProvider, AuthenticationError, BadRequestError, type BaseChunk, ChecksumError, type Chunk, ConflictError, type CreateJobParams, type DocType, type Document, type DocumentChunk, type DocumentChunkGetParams, type DocumentChunkListParams, type DocumentChunkListResponse, type DocumentChunkPagination, type DocumentChunkResponse, type DocumentChunkType, type DocumentListPagination, type DocumentListParams, type DocumentListResponse, type DocumentMetadata, Documents, type FileIndex, GatewayTimeoutError, type ImageChunk, InternalServerError, InvalidStateError, type Job, type JobError, JobFailedError, type JobResult, type JobStatus, Jobs, Knowhere, KnowhereError, type KnowhereOptions, Knowledge, type KnowledgeAsyncJobStatusResponse, type KnowledgeAsyncParseParams, type KnowledgeAsyncParseResponse, type KnowledgeCacheDocumentParams, type KnowledgeCacheJobResultParams, type KnowledgeChunkType, type KnowledgeDocumentReference, type KnowledgeGrepMatch, type KnowledgeGrepParams, type KnowledgeGrepResponse, type KnowledgeOutline, type KnowledgeParseParams, type KnowledgeReadChunk, type KnowledgeReadParams, type KnowledgeReadResponse, type KnowledgeSearchParams, type KnowledgeSearchReference, type KnowledgeSearchResponse, type KnowledgeSearchResult, type KnowledgeSection, type KnowledgeStartupRecoveryResponse, type LoadOptions, type LocalKnowledgeDocument, type LocalKnowledgeParseResponse, LocalKnowledgeStore, type Manifest, NetworkError, NotFoundError, type ParseParams, type ParseResult, type ParsingModel, type ParsingParams, PaymentRequiredError, PermissionDeniedError, type PollProgress, PollingTimeoutError, RateLimitError, Retrieval, type RetrievalChannel, type RetrievalFilterMode, type RetrievalQueryParams, type RetrievalQueryResponse, type RetrievalReferencedChunk, type RetrievalResult, type RetrievalSectionExclusion, type RetrievalSource, ServiceUnavailableError, type Statistics, type TableChunk, type TextChunk, TimeoutError, type UploadParams, type UploadProgress, VERSION, ValidationError, type WaitOptions, type WebhookConfig, Knowhere as default };

package/dist/index.js

@@ -1438,12 +1438,11 @@ var Documents = class extends BaseResource {
    * List canonical documents in a namespace.
    */
   async list(params) {
-    const requestConfig = params?.namespace ? {
-      params: {
-        namespace: params.namespace
-      }
-    } : void 0;
-    return this.httpClient.get("/v1/documents", requestConfig);
+    const response = await this.httpClient.get(
+      "/v1/documents",
+      this.createDocumentListRequestConfig(params)
+    );
+    return this.normalizeDocumentListResponse(response);
   }
   /**
    * Get one canonical document by ID.
@@ -1475,6 +1474,38 @@ var Documents = class extends BaseResource {
   async archive(documentId) {
     return this.httpClient.post(`/v1/documents/${documentId}/archive`);
   }
+  createDocumentListRequestConfig(params) {
+    if (!params) {
+      return void 0;
+    }
+    const queryParams = {};
+    if (params.namespace !== void 0) {
+      queryParams.namespace = params.namespace;
+    }
+    if (params.page !== void 0) {
+      queryParams.page = params.page;
+    }
+    if (params.pageSize !== void 0) {
+      queryParams.page_size = params.pageSize;
+    }
+    return Object.keys(queryParams).length > 0 ? { params: queryParams } : void 0;
+  }
+  normalizeDocumentListResponse(response) {
+    const maybePaginatedResponse = response;
+    if (maybePaginatedResponse.pagination) {
+      return response;
+    }
+    const total = response.documents.length;
+    return {
+      ...response,
+      pagination: {
+        page: 1,
+        pageSize: total,
+        total,
+        totalPages: total > 0 ? 1 : 0
+      }
+    };
+  }
   createChunkListRequestConfig(params) {
     if (!params) {
       return void 0;
@@ -1489,18 +1520,18 @@ var Documents = class extends BaseResource {
     if (params.chunkType !== void 0) {
       queryParams.chunk_type = params.chunkType;
     }
-    if (params.includeAssetUrls === true) {
-      queryParams.include_asset_urls = true;
+    if (params.includeAssetUrls !== void 0) {
+      queryParams.include_asset_urls = params.includeAssetUrls;
     }
     return Object.keys(queryParams).length > 0 ? { params: queryParams } : void 0;
   }
   createChunkGetRequestConfig(params) {
-    if (params?.includeAssetUrls !== true) {
+    if (params?.includeAssetUrls === void 0) {
       return void 0;
     }
     return {
       params: {
-        include_asset_urls: true
+        include_asset_urls: params.includeAssetUrls
       }
     };
   }

package/dist/index.mjs

@@ -1378,12 +1378,11 @@ var Documents = class extends BaseResource {
    * List canonical documents in a namespace.
    */
   async list(params) {
-    const requestConfig = params?.namespace ? {
-      params: {
-        namespace: params.namespace
-      }
-    } : void 0;
-    return this.httpClient.get("/v1/documents", requestConfig);
+    const response = await this.httpClient.get(
+      "/v1/documents",
+      this.createDocumentListRequestConfig(params)
+    );
+    return this.normalizeDocumentListResponse(response);
   }
   /**
    * Get one canonical document by ID.
@@ -1415,6 +1414,38 @@ var Documents = class extends BaseResource {
   async archive(documentId) {
     return this.httpClient.post(`/v1/documents/${documentId}/archive`);
   }
+  createDocumentListRequestConfig(params) {
+    if (!params) {
+      return void 0;
+    }
+    const queryParams = {};
+    if (params.namespace !== void 0) {
+      queryParams.namespace = params.namespace;
+    }
+    if (params.page !== void 0) {
+      queryParams.page = params.page;
+    }
+    if (params.pageSize !== void 0) {
+      queryParams.page_size = params.pageSize;
+    }
+    return Object.keys(queryParams).length > 0 ? { params: queryParams } : void 0;
+  }
+  normalizeDocumentListResponse(response) {
+    const maybePaginatedResponse = response;
+    if (maybePaginatedResponse.pagination) {
+      return response;
+    }
+    const total = response.documents.length;
+    return {
+      ...response,
+      pagination: {
+        page: 1,
+        pageSize: total,
+        total,
+        totalPages: total > 0 ? 1 : 0
+      }
+    };
+  }
   createChunkListRequestConfig(params) {
     if (!params) {
       return void 0;
@@ -1429,18 +1460,18 @@ var Documents = class extends BaseResource {
     if (params.chunkType !== void 0) {
       queryParams.chunk_type = params.chunkType;
     }
-    if (params.includeAssetUrls === true) {
-      queryParams.include_asset_urls = true;
+    if (params.includeAssetUrls !== void 0) {
+      queryParams.include_asset_urls = params.includeAssetUrls;
     }
     return Object.keys(queryParams).length > 0 ? { params: queryParams } : void 0;
   }
   createChunkGetRequestConfig(params) {
-    if (params?.includeAssetUrls !== true) {
+    if (params?.includeAssetUrls === void 0) {
       return void 0;
     }
     return {
       params: {
-        include_asset_urls: true
+        include_asset_urls: params.includeAssetUrls
       }
     };
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ontos-ai/knowhere-sdk",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Official Node.js SDK for Knowhere document parsing API",
   "keywords": [
     "knowhere",