import { BaseClient } from "../client-base.js"; import type { AddDocumentRequest, AddDocumentResponse, CreateKnowledgeBaseRequest, CreateKnowledgeBaseResponse, DeleteDocumentsRequest, DeleteDocumentsResponse, GetDocumentResponse, GetKnowledgeBaseResponse, GetUploadUrlResponse, KnowledgeBaseInfo, ListFilesResponse, PaginatedResponse, QueryKnowledgeBaseRequest, QueryKnowledgeBaseResponse, RegisterFileUploadRequest, RegisterFileUploadResponse, RequestOptions, UploadFileResponse } from "../types.js"; /** * KnowledgeClient provides access to the Opper Knowledge Base API (v2). * * Knowledge bases allow you to store, index, and query documents using * vector embeddings for semantic search. */ export declare class KnowledgeClient extends BaseClient { /** * Create a new knowledge base. * * @param body - Name and optional embedding model configuration. * @param options - Optional request options. * @returns The created knowledge base. */ create(body: CreateKnowledgeBaseRequest, options?: RequestOptions): Promise; /** * List all knowledge bases with pagination. * * @param params - Optional offset and limit for pagination. * @param options - Optional request options. * @returns Paginated list of knowledge bases. */ list(params?: { offset?: number; limit?: number; }, options?: RequestOptions): Promise>; /** * Get a knowledge base by ID. * * @param id - The knowledge base UUID. * @param options - Optional request options. * @returns Knowledge base details including document count. */ getById(id: string, options?: RequestOptions): Promise; /** * Get a knowledge base by name. * * @param name - The knowledge base name. * @param options - Optional request options. * @returns Knowledge base details including document count. */ getByName(name: string, options?: RequestOptions): Promise; /** * Delete a knowledge base and all its contents. * * @param id - The knowledge base UUID. * @param options - Optional request options. */ delete(id: string, options?: RequestOptions): Promise; /** * Add a text document to a knowledge base. * * The document will be chunked and embedded automatically. * * @param knowledgeBaseId - The knowledge base UUID. * @param body - Document content, optional key, metadata, and chunking configuration. * @param options - Optional request options. * @returns The added document metadata. */ add(knowledgeBaseId: string, body: AddDocumentRequest, options?: RequestOptions): Promise; /** * Query a knowledge base using semantic search. * * @param knowledgeBaseId - The knowledge base UUID. * @param body - Query string, filters, and result configuration. * @param options - Optional request options. * @returns Array of matching documents with relevance scores. */ query(knowledgeBaseId: string, body: QueryKnowledgeBaseRequest, options?: RequestOptions): Promise; /** * Get a document by its key. * * @param knowledgeBaseId - The knowledge base UUID. * @param documentKey - The document key. * @param options - Optional request options. * @returns The document with its segments and metadata. */ getDocument(knowledgeBaseId: string, documentKey: string, options?: RequestOptions): Promise; /** * Delete documents from a knowledge base using optional filters. * If no filters are provided, all documents are deleted. * * @param knowledgeBaseId - The knowledge base UUID. * @param body - Optional filters to select documents for deletion. * @param options - Optional request options. * @returns The count of deleted documents. */ deleteDocuments(knowledgeBaseId: string, body?: DeleteDocumentsRequest, options?: RequestOptions): Promise; /** * Upload a file directly to a knowledge base. * * The file will be processed, chunked, and indexed automatically. * Supports PDF, TXT, DOCX, MD, HTML, RTF, and more (max 50MB). * * @param knowledgeBaseId - The knowledge base UUID. * @param file - The file to upload (Blob, File, or Buffer). * @param params - Optional chunking configuration and metadata. * @param options - Optional request options. * @returns The uploaded file metadata. */ uploadFile(knowledgeBaseId: string, file: Blob, params?: { filename?: string; chunkSize?: number; chunkOverlap?: number; metadata?: Record; }, options?: RequestOptions): Promise; /** * Get a presigned URL for uploading a file to S3. * * This is step 1 of the 3-step upload process: * 1. Get upload URL → 2. Upload to S3 → 3. Register file * * @param knowledgeBaseId - The knowledge base UUID. * @param filename - The name of the file to upload. * @param options - Optional request options. * @returns Presigned URL, form fields, and file ID. */ getUploadUrl(knowledgeBaseId: string, filename: string, options?: RequestOptions): Promise; /** * Register a file after uploading it to S3. * * This is step 3 of the 3-step upload process. * * @param knowledgeBaseId - The knowledge base UUID. * @param body - File registration details. * @param options - Optional request options. * @returns The registered file metadata. */ registerFileUpload(knowledgeBaseId: string, body: RegisterFileUploadRequest, options?: RequestOptions): Promise; /** * List files in a knowledge base with pagination. * * @param knowledgeBaseId - The knowledge base UUID. * @param params - Optional offset and limit for pagination. * @param options - Optional request options. * @returns Paginated list of files. */ listFiles(knowledgeBaseId: string, params?: { offset?: number; limit?: number; }, options?: RequestOptions): Promise>; /** * Get a presigned download URL for a file. * * @param knowledgeBaseId - The knowledge base UUID. * @param fileId - The file UUID. * @param options - Optional request options. * @returns Object containing the download URL. */ getFileDownloadUrl(knowledgeBaseId: string, fileId: string, options?: RequestOptions): Promise<{ url: string; }>; /** * Delete a file from a knowledge base. * * @param knowledgeBaseId - The knowledge base UUID. * @param fileId - The file UUID. * @param options - Optional request options. */ deleteFile(knowledgeBaseId: string, fileId: string, options?: RequestOptions): Promise; }