@elqnt/kg 2.1.1 → 3.0.0

package/dist/api/index.d.mts

@@ -1,18 +1,35 @@
 import { ApiClientOptions, ApiResponse } from '@elqnt/api-client';
 import { ResponseMetadata } from '@elqnt/types';
-import { CreateGraphRequest, CreateGraphResult, DeleteGraphResult, DeleteDocumentResponse, GetGraphResult, KGLabelInfo, KGNode, KGNodeIngestRequest, KGSyncIngestResponse, ListGraphsResult, KGQuery, KGQueryResult, Graph, UpdateGraphResult } from '../models/kg.mjs';
-import { GraphEdgeDefinition, GraphEdgeResponse, GraphNodeDefinition, GraphNodeResponse } from '../models/kg-designer.mjs';
+import { ListGraphsResult, GetGraphResult, CreateGraphRequest, CreateGraphResult, Graph, UpdateGraphResult, DeleteGraphResult, KGQuery, KGQueryResult, KGLabelInfo, KGNode, KGNodeIngestRequest, KGSyncIngestResponse, DeleteDocumentResponse } from '../models/kg.mjs';
+import { GraphNodeResponse, GraphNodeDefinition, GraphEdgeResponse, GraphEdgeDefinition } from '../models/kg-designer.mjs';
 
 /**
- * Knowledge Graph API functions
+ * Knowledge Graph Browser API
  *
  * Browser-side API client for KG operations.
  * Uses @elqnt/api-client for HTTP requests with automatic token management.
+ *
+ * @example
+ * ```ts
+ * import { listGraphsApi, queryGraphApi } from "@elqnt/kg/api";
+ *
+ * const graphs = await listGraphsApi({ baseUrl, orgId });
+ * const result = await queryGraphApi(query, { baseUrl, orgId, graphId });
+ * ```
+ *
+ * @packageDocumentation
  */
 
+/**
+ * Options for KG API calls that may include a graph ID
+ */
 interface KGApiOptions extends ApiClientOptions {
+    /** Optional graph ID for graph-scoped operations */
     graphId?: string;
 }
+/**
+ * Crawl job information
+ */
 interface CrawlJob {
     id: string;
     baseUrl: string;
@@ -23,18 +40,30 @@ interface CrawlJob {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Response for listing crawl jobs
+ */
 interface CrawlJobsListResponse {
     jobs: CrawlJob[];
     total: number;
 }
+/**
+ * Response for crawl job status
+ */
 interface CrawlJobStatusResponse {
     job: CrawlJob;
     success: boolean;
 }
+/**
+ * Response for starting a crawl job
+ */
 interface CrawlJobStartResponse {
     jobId: string;
     success: boolean;
 }
+/**
+ * Response for listing crawled pages
+ */
 interface CrawledPagesResponse {
     pages: Array<{
         url: string;
@@ -44,24 +73,125 @@ interface CrawledPagesResponse {
     }>;
     total: number;
 }
+/**
+ * List all knowledge graphs for the organization
+ *
+ * @param options - API client options (baseUrl, orgId)
+ * @returns List of graphs
+ *
+ * @example
+ * ```ts
+ * const response = await listGraphsApi({ baseUrl: "http://api-gateway:80", orgId: "org-123" });
+ * if (response.data?.graphs) {
+ *   console.log("Graphs:", response.data.graphs);
+ * }
+ * ```
+ */
 declare function listGraphsApi(options: ApiClientOptions): Promise<ApiResponse<ListGraphsResult>>;
+/**
+ * Get a specific knowledge graph by ID
+ *
+ * @param graphId - The graph ID
+ * @param options - API client options
+ * @returns The graph details
+ */
 declare function getGraphApi(graphId: string, options: ApiClientOptions): Promise<ApiResponse<GetGraphResult>>;
+/**
+ * Create a new knowledge graph
+ *
+ * @param graph - Graph creation request
+ * @param options - API client options
+ * @returns The created graph
+ */
 declare function createGraphApi(graph: CreateGraphRequest, options: ApiClientOptions): Promise<ApiResponse<CreateGraphResult>>;
+/**
+ * Update an existing knowledge graph
+ *
+ * @param graphId - The graph ID to update
+ * @param updates - Partial graph updates
+ * @param options - API client options
+ * @returns The updated graph
+ */
 declare function updateGraphApi(graphId: string, updates: Partial<Graph>, options: ApiClientOptions): Promise<ApiResponse<UpdateGraphResult>>;
+/**
+ * Delete a knowledge graph
+ *
+ * @param graphId - The graph ID to delete
+ * @param options - API client options
+ * @returns Success/failure result
+ */
 declare function deleteGraphApi(graphId: string, options: ApiClientOptions): Promise<ApiResponse<DeleteGraphResult>>;
+/**
+ * Query knowledge graph nodes
+ *
+ * @param query - The KG query parameters
+ * @param options - API options including optional graphId
+ * @returns Query results with matching nodes and edges
+ *
+ * @example
+ * ```ts
+ * const result = await queryGraphApi(
+ *   { label: "Person", fields: [], limit: 10, depth: 1, sortBy: "", sortOrder: "" },
+ *   { baseUrl, orgId, graphId }
+ * );
+ * ```
+ */
 declare function queryGraphApi(query: KGQuery, options: KGApiOptions): Promise<ApiResponse<KGQueryResult>>;
+/**
+ * Get all node labels in the knowledge graph
+ *
+ * @param options - API options including optional graphId
+ * @returns List of labels with counts
+ */
 declare function getGraphLabelsApi(options: KGApiOptions): Promise<ApiResponse<{
     labels: KGLabelInfo[];
 }>>;
+/**
+ * Get a specific KG node by ID
+ *
+ * @param nodeId - The node ID
+ * @param options - API options including optional graphId
+ * @returns The node details
+ */
 declare function getKGNodeApi(nodeId: string, options: KGApiOptions): Promise<ApiResponse<{
     node: KGNode;
 }>>;
+/**
+ * Ingest a new node into the knowledge graph
+ *
+ * @param node - Node ingest request
+ * @param options - API options including optional graphId
+ * @returns The created node ID
+ */
 declare function ingestKGNodeApi(node: KGNodeIngestRequest, options: KGApiOptions): Promise<ApiResponse<KGSyncIngestResponse>>;
+/**
+ * Update an existing KG node
+ *
+ * @param nodeId - The node ID to update
+ * @param updates - Partial node updates
+ * @param options - API options including optional graphId
+ * @returns Success/failure result
+ */
 declare function updateKGNodeApi(nodeId: string, updates: Partial<KGNode>, options: KGApiOptions): Promise<ApiResponse<{
     success: boolean;
     metadata: ResponseMetadata;
 }>>;
+/**
+ * Get connection statistics for a node
+ *
+ * @param nodeId - The node ID
+ * @param edgeLabel - The edge label to filter by
+ * @param options - API options including optional graphId
+ * @returns Connection counts by label
+ */
 declare function getNodeConnectionStatsApi(nodeId: string, edgeLabel: string, options: KGApiOptions): Promise<ApiResponse<Record<string, number>>>;
+/**
+ * Ingest a document into the knowledge graph
+ *
+ * @param document - Document to ingest
+ * @param options - API options including optional graphId
+ * @returns Success/failure result
+ */
 declare function ingestDocumentApi(document: {
     id: string;
     title: string;
@@ -72,39 +202,156 @@ declare function ingestDocumentApi(document: {
     success: boolean;
     metadata: ResponseMetadata;
 }>>;
+/**
+ * Delete a document from the knowledge graph
+ *
+ * @param documentId - The document ID to delete
+ * @param options - API options including optional graphId
+ * @returns Deletion result with counts
+ */
 declare function deleteKGDocumentApi(documentId: string, options: KGApiOptions): Promise<ApiResponse<DeleteDocumentResponse>>;
+/**
+ * Optimize the knowledge graph
+ *
+ * @param options - API options including optional graphId
+ * @returns Success/failure result
+ */
 declare function optimizeGraphApi(options: KGApiOptions): Promise<ApiResponse<{
     success: boolean;
     metadata: ResponseMetadata;
 }>>;
+/**
+ * List all node definitions in the graph designer
+ *
+ * @param options - API options including optional graphId
+ * @returns List of node definitions
+ */
 declare function listDesignerNodesApi(options: KGApiOptions): Promise<ApiResponse<GraphNodeResponse>>;
+/**
+ * Get a specific node definition by label
+ *
+ * @param label - The node label
+ * @param options - API options including optional graphId
+ * @returns The node definition
+ */
 declare function getDesignerNodeApi(label: string, options: KGApiOptions): Promise<ApiResponse<GraphNodeResponse>>;
+/**
+ * Create a new node definition
+ *
+ * @param node - Node definition to create
+ * @param options - API options including optional graphId
+ * @returns The created node definition
+ */
 declare function createDesignerNodeApi(node: Omit<GraphNodeDefinition, "createdAt" | "updatedAt">, options: KGApiOptions): Promise<ApiResponse<GraphNodeResponse>>;
+/**
+ * Update an existing node definition
+ *
+ * @param label - The node label to update
+ * @param node - Partial node definition updates
+ * @param options - API options including optional graphId
+ * @returns The updated node definition
+ */
 declare function updateDesignerNodeApi(label: string, node: Partial<GraphNodeDefinition>, options: KGApiOptions): Promise<ApiResponse<GraphNodeResponse>>;
+/**
+ * Delete a node definition
+ *
+ * @param label - The node label to delete
+ * @param options - API options including optional graphId
+ * @returns Success/failure result
+ */
 declare function deleteDesignerNodeApi(label: string, options: KGApiOptions): Promise<ApiResponse<{
     success: boolean;
     metadata: ResponseMetadata;
 }>>;
+/**
+ * List all edge definitions in the graph designer
+ *
+ * @param options - API options including optional graphId
+ * @returns List of edge definitions
+ */
 declare function listDesignerEdgesApi(options: KGApiOptions): Promise<ApiResponse<GraphEdgeResponse>>;
+/**
+ * Get a specific edge definition by label
+ *
+ * @param label - The edge label
+ * @param options - API options including optional graphId
+ * @returns The edge definition
+ */
 declare function getDesignerEdgeApi(label: string, options: KGApiOptions): Promise<ApiResponse<GraphEdgeResponse>>;
+/**
+ * Create a new edge definition
+ *
+ * @param edge - Edge definition to create
+ * @param options - API options including optional graphId
+ * @returns The created edge definition
+ */
 declare function createDesignerEdgeApi(edge: Omit<GraphEdgeDefinition, "createdAt" | "updatedAt">, options: KGApiOptions): Promise<ApiResponse<GraphEdgeResponse>>;
+/**
+ * Update an existing edge definition
+ *
+ * @param label - The edge label to update
+ * @param edge - Partial edge definition updates
+ * @param options - API options including optional graphId
+ * @returns The updated edge definition
+ */
 declare function updateDesignerEdgeApi(label: string, edge: Partial<GraphEdgeDefinition>, options: KGApiOptions): Promise<ApiResponse<GraphEdgeResponse>>;
+/**
+ * Delete an edge definition
+ *
+ * @param label - The edge label to delete
+ * @param options - API options including optional graphId
+ * @returns Success/failure result
+ */
 declare function deleteDesignerEdgeApi(label: string, options: KGApiOptions): Promise<ApiResponse<{
     success: boolean;
     metadata: ResponseMetadata;
 }>>;
+/**
+ * List crawl jobs
+ *
+ * @param options - API options including optional graphId, limit, offset, status
+ * @returns List of crawl jobs with total count
+ */
 declare function listCrawlJobsApi(options: KGApiOptions & {
     limit?: number;
     offset?: number;
     status?: string;
 }): Promise<ApiResponse<CrawlJobsListResponse>>;
+/**
+ * Start a new crawl job
+ *
+ * @param params - Crawl job parameters
+ * @param options - API options including optional graphId
+ * @returns The created job ID
+ */
 declare function startCrawlJobApi(params: {
     baseUrl: string;
     depth: number;
     maxPages: number;
 }, options: KGApiOptions): Promise<ApiResponse<CrawlJobStartResponse>>;
+/**
+ * Get crawl job status
+ *
+ * @param jobId - The job ID
+ * @param options - API options including optional graphId
+ * @returns The job status
+ */
 declare function getCrawlJobStatusApi(jobId: string, options: KGApiOptions): Promise<ApiResponse<CrawlJobStatusResponse>>;
+/**
+ * Cancel a crawl job
+ *
+ * @param jobId - The job ID to cancel
+ * @param options - API options including optional graphId
+ * @returns The updated job status
+ */
 declare function cancelCrawlJobApi(jobId: string, options: KGApiOptions): Promise<ApiResponse<CrawlJobStatusResponse>>;
+/**
+ * Get pages crawled by a job
+ *
+ * @param jobId - The job ID
+ * @param options - API options including optional graphId
+ * @returns List of crawled pages
+ */
 declare function getCrawledPagesApi(jobId: string, options: KGApiOptions): Promise<ApiResponse<CrawledPagesResponse>>;
 
 export { type CrawlJob, type CrawlJobStartResponse, type CrawlJobStatusResponse, type CrawlJobsListResponse, type CrawledPagesResponse, type KGApiOptions, cancelCrawlJobApi, createDesignerEdgeApi, createDesignerNodeApi, createGraphApi, deleteDesignerEdgeApi, deleteDesignerNodeApi, deleteGraphApi, deleteKGDocumentApi, getCrawlJobStatusApi, getCrawledPagesApi, getDesignerEdgeApi, getDesignerNodeApi, getGraphApi, getGraphLabelsApi, getKGNodeApi, getNodeConnectionStatsApi, ingestDocumentApi, ingestKGNodeApi, listCrawlJobsApi, listDesignerEdgesApi, listDesignerNodesApi, listGraphsApi, optimizeGraphApi, queryGraphApi, startCrawlJobApi, updateDesignerEdgeApi, updateDesignerNodeApi, updateGraphApi, updateKGNodeApi };

package/dist/api/index.d.ts

@@ -1,18 +1,35 @@
 import { ApiClientOptions, ApiResponse } from '@elqnt/api-client';
 import { ResponseMetadata } from '@elqnt/types';
-import { CreateGraphRequest, CreateGraphResult, DeleteGraphResult, DeleteDocumentResponse, GetGraphResult, KGLabelInfo, KGNode, KGNodeIngestRequest, KGSyncIngestResponse, ListGraphsResult, KGQuery, KGQueryResult, Graph, UpdateGraphResult } from '../models/kg.js';
-import { GraphEdgeDefinition, GraphEdgeResponse, GraphNodeDefinition, GraphNodeResponse } from '../models/kg-designer.js';
+import { ListGraphsResult, GetGraphResult, CreateGraphRequest, CreateGraphResult, Graph, UpdateGraphResult, DeleteGraphResult, KGQuery, KGQueryResult, KGLabelInfo, KGNode, KGNodeIngestRequest, KGSyncIngestResponse, DeleteDocumentResponse } from '../models/kg.js';
+import { GraphNodeResponse, GraphNodeDefinition, GraphEdgeResponse, GraphEdgeDefinition } from '../models/kg-designer.js';
 
 /**
- * Knowledge Graph API functions
+ * Knowledge Graph Browser API
  *
  * Browser-side API client for KG operations.
  * Uses @elqnt/api-client for HTTP requests with automatic token management.
+ *
+ * @example
+ * ```ts
+ * import { listGraphsApi, queryGraphApi } from "@elqnt/kg/api";
+ *
+ * const graphs = await listGraphsApi({ baseUrl, orgId });
+ * const result = await queryGraphApi(query, { baseUrl, orgId, graphId });
+ * ```
+ *
+ * @packageDocumentation
  */
 
+/**
+ * Options for KG API calls that may include a graph ID
+ */
 interface KGApiOptions extends ApiClientOptions {
+    /** Optional graph ID for graph-scoped operations */
     graphId?: string;
 }
+/**
+ * Crawl job information
+ */
 interface CrawlJob {
     id: string;
     baseUrl: string;
@@ -23,18 +40,30 @@ interface CrawlJob {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Response for listing crawl jobs
+ */
 interface CrawlJobsListResponse {
     jobs: CrawlJob[];
     total: number;
 }
+/**
+ * Response for crawl job status
+ */
 interface CrawlJobStatusResponse {
     job: CrawlJob;
     success: boolean;
 }
+/**
+ * Response for starting a crawl job
+ */
 interface CrawlJobStartResponse {
     jobId: string;
     success: boolean;
 }
+/**
+ * Response for listing crawled pages
+ */
 interface CrawledPagesResponse {
     pages: Array<{
         url: string;
@@ -44,24 +73,125 @@ interface CrawledPagesResponse {
     }>;
     total: number;
 }
+/**
+ * List all knowledge graphs for the organization
+ *
+ * @param options - API client options (baseUrl, orgId)
+ * @returns List of graphs
+ *
+ * @example
+ * ```ts
+ * const response = await listGraphsApi({ baseUrl: "http://api-gateway:80", orgId: "org-123" });
+ * if (response.data?.graphs) {
+ *   console.log("Graphs:", response.data.graphs);
+ * }
+ * ```
+ */
 declare function listGraphsApi(options: ApiClientOptions): Promise<ApiResponse<ListGraphsResult>>;
+/**
+ * Get a specific knowledge graph by ID
+ *
+ * @param graphId - The graph ID
+ * @param options - API client options
+ * @returns The graph details
+ */
 declare function getGraphApi(graphId: string, options: ApiClientOptions): Promise<ApiResponse<GetGraphResult>>;
+/**
+ * Create a new knowledge graph
+ *
+ * @param graph - Graph creation request
+ * @param options - API client options
+ * @returns The created graph
+ */
 declare function createGraphApi(graph: CreateGraphRequest, options: ApiClientOptions): Promise<ApiResponse<CreateGraphResult>>;
+/**
+ * Update an existing knowledge graph
+ *
+ * @param graphId - The graph ID to update
+ * @param updates - Partial graph updates
+ * @param options - API client options
+ * @returns The updated graph
+ */
 declare function updateGraphApi(graphId: string, updates: Partial<Graph>, options: ApiClientOptions): Promise<ApiResponse<UpdateGraphResult>>;
+/**
+ * Delete a knowledge graph
+ *
+ * @param graphId - The graph ID to delete
+ * @param options - API client options
+ * @returns Success/failure result
+ */
 declare function deleteGraphApi(graphId: string, options: ApiClientOptions): Promise<ApiResponse<DeleteGraphResult>>;
+/**
+ * Query knowledge graph nodes
+ *
+ * @param query - The KG query parameters
+ * @param options - API options including optional graphId
+ * @returns Query results with matching nodes and edges
+ *
+ * @example
+ * ```ts
+ * const result = await queryGraphApi(
+ *   { label: "Person", fields: [], limit: 10, depth: 1, sortBy: "", sortOrder: "" },
+ *   { baseUrl, orgId, graphId }
+ * );
+ * ```
+ */
 declare function queryGraphApi(query: KGQuery, options: KGApiOptions): Promise<ApiResponse<KGQueryResult>>;
+/**
+ * Get all node labels in the knowledge graph
+ *
+ * @param options - API options including optional graphId
+ * @returns List of labels with counts
+ */
 declare function getGraphLabelsApi(options: KGApiOptions): Promise<ApiResponse<{
     labels: KGLabelInfo[];
 }>>;
+/**
+ * Get a specific KG node by ID
+ *
+ * @param nodeId - The node ID
+ * @param options - API options including optional graphId
+ * @returns The node details
+ */
 declare function getKGNodeApi(nodeId: string, options: KGApiOptions): Promise<ApiResponse<{
     node: KGNode;
 }>>;
+/**
+ * Ingest a new node into the knowledge graph
+ *
+ * @param node - Node ingest request
+ * @param options - API options including optional graphId
+ * @returns The created node ID
+ */
 declare function ingestKGNodeApi(node: KGNodeIngestRequest, options: KGApiOptions): Promise<ApiResponse<KGSyncIngestResponse>>;
+/**
+ * Update an existing KG node
+ *
+ * @param nodeId - The node ID to update
+ * @param updates - Partial node updates
+ * @param options - API options including optional graphId
+ * @returns Success/failure result
+ */
 declare function updateKGNodeApi(nodeId: string, updates: Partial<KGNode>, options: KGApiOptions): Promise<ApiResponse<{
     success: boolean;
     metadata: ResponseMetadata;
 }>>;
+/**
+ * Get connection statistics for a node
+ *
+ * @param nodeId - The node ID
+ * @param edgeLabel - The edge label to filter by
+ * @param options - API options including optional graphId
+ * @returns Connection counts by label
+ */
 declare function getNodeConnectionStatsApi(nodeId: string, edgeLabel: string, options: KGApiOptions): Promise<ApiResponse<Record<string, number>>>;
+/**
+ * Ingest a document into the knowledge graph
+ *
+ * @param document - Document to ingest
+ * @param options - API options including optional graphId
+ * @returns Success/failure result
+ */
 declare function ingestDocumentApi(document: {
     id: string;
     title: string;
@@ -72,39 +202,156 @@ declare function ingestDocumentApi(document: {
     success: boolean;
     metadata: ResponseMetadata;
 }>>;
+/**
+ * Delete a document from the knowledge graph
+ *
+ * @param documentId - The document ID to delete
+ * @param options - API options including optional graphId
+ * @returns Deletion result with counts
+ */
 declare function deleteKGDocumentApi(documentId: string, options: KGApiOptions): Promise<ApiResponse<DeleteDocumentResponse>>;
+/**
+ * Optimize the knowledge graph
+ *
+ * @param options - API options including optional graphId
+ * @returns Success/failure result
+ */
 declare function optimizeGraphApi(options: KGApiOptions): Promise<ApiResponse<{
     success: boolean;
     metadata: ResponseMetadata;
 }>>;
+/**
+ * List all node definitions in the graph designer
+ *
+ * @param options - API options including optional graphId
+ * @returns List of node definitions
+ */
 declare function listDesignerNodesApi(options: KGApiOptions): Promise<ApiResponse<GraphNodeResponse>>;
+/**
+ * Get a specific node definition by label
+ *
+ * @param label - The node label
+ * @param options - API options including optional graphId
+ * @returns The node definition
+ */
 declare function getDesignerNodeApi(label: string, options: KGApiOptions): Promise<ApiResponse<GraphNodeResponse>>;
+/**
+ * Create a new node definition
+ *
+ * @param node - Node definition to create
+ * @param options - API options including optional graphId
+ * @returns The created node definition
+ */
 declare function createDesignerNodeApi(node: Omit<GraphNodeDefinition, "createdAt" | "updatedAt">, options: KGApiOptions): Promise<ApiResponse<GraphNodeResponse>>;
+/**
+ * Update an existing node definition
+ *
+ * @param label - The node label to update
+ * @param node - Partial node definition updates
+ * @param options - API options including optional graphId
+ * @returns The updated node definition
+ */
 declare function updateDesignerNodeApi(label: string, node: Partial<GraphNodeDefinition>, options: KGApiOptions): Promise<ApiResponse<GraphNodeResponse>>;
+/**
+ * Delete a node definition
+ *
+ * @param label - The node label to delete
+ * @param options - API options including optional graphId
+ * @returns Success/failure result
+ */
 declare function deleteDesignerNodeApi(label: string, options: KGApiOptions): Promise<ApiResponse<{
     success: boolean;
     metadata: ResponseMetadata;
 }>>;
+/**
+ * List all edge definitions in the graph designer
+ *
+ * @param options - API options including optional graphId
+ * @returns List of edge definitions
+ */
 declare function listDesignerEdgesApi(options: KGApiOptions): Promise<ApiResponse<GraphEdgeResponse>>;
+/**
+ * Get a specific edge definition by label
+ *
+ * @param label - The edge label
+ * @param options - API options including optional graphId
+ * @returns The edge definition
+ */
 declare function getDesignerEdgeApi(label: string, options: KGApiOptions): Promise<ApiResponse<GraphEdgeResponse>>;
+/**
+ * Create a new edge definition
+ *
+ * @param edge - Edge definition to create
+ * @param options - API options including optional graphId
+ * @returns The created edge definition
+ */
 declare function createDesignerEdgeApi(edge: Omit<GraphEdgeDefinition, "createdAt" | "updatedAt">, options: KGApiOptions): Promise<ApiResponse<GraphEdgeResponse>>;
+/**
+ * Update an existing edge definition
+ *
+ * @param label - The edge label to update
+ * @param edge - Partial edge definition updates
+ * @param options - API options including optional graphId
+ * @returns The updated edge definition
+ */
 declare function updateDesignerEdgeApi(label: string, edge: Partial<GraphEdgeDefinition>, options: KGApiOptions): Promise<ApiResponse<GraphEdgeResponse>>;
+/**
+ * Delete an edge definition
+ *
+ * @param label - The edge label to delete
+ * @param options - API options including optional graphId
+ * @returns Success/failure result
+ */
 declare function deleteDesignerEdgeApi(label: string, options: KGApiOptions): Promise<ApiResponse<{
     success: boolean;
     metadata: ResponseMetadata;
 }>>;
+/**
+ * List crawl jobs
+ *
+ * @param options - API options including optional graphId, limit, offset, status
+ * @returns List of crawl jobs with total count
+ */
 declare function listCrawlJobsApi(options: KGApiOptions & {
     limit?: number;
     offset?: number;
     status?: string;
 }): Promise<ApiResponse<CrawlJobsListResponse>>;
+/**
+ * Start a new crawl job
+ *
+ * @param params - Crawl job parameters
+ * @param options - API options including optional graphId
+ * @returns The created job ID
+ */
 declare function startCrawlJobApi(params: {
     baseUrl: string;
     depth: number;
     maxPages: number;
 }, options: KGApiOptions): Promise<ApiResponse<CrawlJobStartResponse>>;
+/**
+ * Get crawl job status
+ *
+ * @param jobId - The job ID
+ * @param options - API options including optional graphId
+ * @returns The job status
+ */
 declare function getCrawlJobStatusApi(jobId: string, options: KGApiOptions): Promise<ApiResponse<CrawlJobStatusResponse>>;
+/**
+ * Cancel a crawl job
+ *
+ * @param jobId - The job ID to cancel
+ * @param options - API options including optional graphId
+ * @returns The updated job status
+ */
 declare function cancelCrawlJobApi(jobId: string, options: KGApiOptions): Promise<ApiResponse<CrawlJobStatusResponse>>;
+/**
+ * Get pages crawled by a job
+ *
+ * @param jobId - The job ID
+ * @param options - API options including optional graphId
+ * @returns List of crawled pages
+ */
 declare function getCrawledPagesApi(jobId: string, options: KGApiOptions): Promise<ApiResponse<CrawledPagesResponse>>;
 
 export { type CrawlJob, type CrawlJobStartResponse, type CrawlJobStatusResponse, type CrawlJobsListResponse, type CrawledPagesResponse, type KGApiOptions, cancelCrawlJobApi, createDesignerEdgeApi, createDesignerNodeApi, createGraphApi, deleteDesignerEdgeApi, deleteDesignerNodeApi, deleteGraphApi, deleteKGDocumentApi, getCrawlJobStatusApi, getCrawledPagesApi, getDesignerEdgeApi, getDesignerNodeApi, getGraphApi, getGraphLabelsApi, getKGNodeApi, getNodeConnectionStatsApi, ingestDocumentApi, ingestKGNodeApi, listCrawlJobsApi, listDesignerEdgesApi, listDesignerNodesApi, listGraphsApi, optimizeGraphApi, queryGraphApi, startCrawlJobApi, updateDesignerEdgeApi, updateDesignerNodeApi, updateGraphApi, updateKGNodeApi };