@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/docs/PathPartsApi.md

@@ -0,0 +1,314 @@
+# PathPartsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**bulkAddPathPartTags**](PathPartsApi.md#bulkaddpathparttags) | **POST** /v1/path-parts/{path_part_id}/tags | Bulk Add Path Part Tags Handler |
+| [**bulkRemovePathPartTags**](PathPartsApi.md#bulkremovepathparttags) | **DELETE** /v1/path-parts/{path_part_id}/tags | Bulk Remove Path Part Tags Handler |
+| [**getPathPart**](PathPartsApi.md#getpathpart) | **GET** /v1/path-parts/{path_part_id} | Get Path Part Handler |
+| [**listPathParts**](PathPartsApi.md#listpathparts) | **GET** /v1/path-parts | List Path Parts Handler |
+
+
+
+## bulkAddPathPartTags
+
+> PathPartTagsResponse bulkAddPathPartTags(pathPartId, bulkTagRequest, ksUat)
+
+Bulk Add Path Part Tags Handler
+
+Bulk add tags to a path part.  Idempotent — already-attached tags are skipped. Returns 400 if any tag_id doesn\'t exist (FK violation). Requires write permission on the target path part.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PathPartsApi,
+} from '@knowledge-stack/ksapi';
+import type { BulkAddPathPartTagsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new PathPartsApi();
+
+  const body = {
+    // string
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // BulkTagRequest
+    bulkTagRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies BulkAddPathPartTagsRequest;
+
+  try {
+    const data = await api.bulkAddPathPartTags(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` |  | [Defaults to `undefined`] |
+| **bulkTagRequest** | [BulkTagRequest](BulkTagRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PathPartTagsResponse**](PathPartTagsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## bulkRemovePathPartTags
+
+> PathPartTagsResponse bulkRemovePathPartTags(pathPartId, bulkTagRequest, ksUat)
+
+Bulk Remove Path Part Tags Handler
+
+Bulk remove tags from a path part.  Silently ignores tags that aren\'t attached. Requires write permission on the target path part.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PathPartsApi,
+} from '@knowledge-stack/ksapi';
+import type { BulkRemovePathPartTagsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new PathPartsApi();
+
+  const body = {
+    // string
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // BulkTagRequest
+    bulkTagRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies BulkRemovePathPartTagsRequest;
+
+  try {
+    const data = await api.bulkRemovePathPartTags(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` |  | [Defaults to `undefined`] |
+| **bulkTagRequest** | [BulkTagRequest](BulkTagRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PathPartTagsResponse**](PathPartTagsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPathPart
+
+> PathPartResponse getPathPart(pathPartId, ksUat)
+
+Get Path Part Handler
+
+Get a path part by its ID.  Returns the path part with its attached tag IDs.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PathPartsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetPathPartRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new PathPartsApi();
+
+  const body = {
+    // string
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetPathPartRequest;
+
+  try {
+    const data = await api.getPathPart(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PathPartResponse**](PathPartResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listPathParts
+
+> PaginatedResponsePathPartResponse listPathParts(parentPathId, maxDepth, sortOrder, limit, offset, ksUat)
+
+List Path Parts Handler
+
+List path parts (folders) under a parent with traversal.  This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts.  - If parent_path_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.  For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PathPartsApi,
+} from '@knowledge-stack/ksapi';
+import type { ListPathPartsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new PathPartsApi();
+
+  const body = {
+    // string | Parent PathPart ID (defaults to root) (optional)
+    parentPathId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // number | Maximum depth to traverse (1 = direct children, default: 1) (optional)
+    maxDepth: 56,
+    // PathOrder | Sort order for results (default: LOGICAL) (optional)
+    sortOrder: ...,
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListPathPartsRequest;
+
+  try {
+    const data = await api.listPathParts(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **parentPathId** | `string` | Parent PathPart ID (defaults to root) | [Optional] [Defaults to `undefined`] |
+| **maxDepth** | `number` | Maximum depth to traverse (1 = direct children, default: 1) | [Optional] [Defaults to `1`] |
+| **sortOrder** | `PathOrder` | Sort order for results (default: LOGICAL) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT] |
+| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedResponsePathPartResponse**](PaginatedResponsePathPartResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/PermissionCapability.md

@@ -0,0 +1,33 @@
+
+# PermissionCapability
+
+Permission capability.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { PermissionCapability } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies PermissionCapability
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PermissionCapability
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PermissionResponse.md

@@ -0,0 +1,48 @@
+
+# PermissionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`tenantId` | string
+`userId` | string
+`pathPartId` | string
+`materializedPath` | string
+`capability` | [PermissionCapability](PermissionCapability.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { PermissionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "tenantId": null,
+  "userId": null,
+  "pathPartId": null,
+  "materializedPath": null,
+  "capability": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies PermissionResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PermissionResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PipelineState.md

@@ -0,0 +1,45 @@
+
+# PipelineState
+
+Pipeline execution state tracking.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [PipelineStatus](PipelineStatus.md)
+`lastRunTimestamp` | Date
+`lastActivity` | string
+`error` | string
+`temporalWorkflowId` | string
+`chunksProcessed` | number
+
+## Example
+
+```typescript
+import type { PipelineState } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "lastRunTimestamp": null,
+  "lastActivity": null,
+  "error": null,
+  "temporalWorkflowId": null,
+  "chunksProcessed": null,
+} satisfies PipelineState
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PipelineState
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PipelineStatus.md

@@ -0,0 +1,33 @@
+
+# PipelineStatus
+
+Status of the ingestion pipeline workflow.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { PipelineStatus } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies PipelineStatus
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PipelineStatus
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Polygon.md

@@ -0,0 +1,41 @@
+
+# Polygon
+
+Bounding box polygon.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`x` | number
+`y` | number
+`width` | number
+`height` | number
+
+## Example
+
+```typescript
+import type { Polygon } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "x": null,
+  "y": null,
+  "width": null,
+  "height": null,
+} satisfies Polygon
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Polygon
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PolygonReference.md

@@ -0,0 +1,37 @@
+
+# PolygonReference
+
+Reference to a polygon on a specific page.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`polygon` | [Polygon](Polygon.md)
+
+## Example
+
+```typescript
+import type { PolygonReference } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "polygon": null,
+} satisfies PolygonReference
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PolygonReference
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RootResponse.md

@@ -0,0 +1,36 @@
+
+# RootResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`service` | string
+`docs` | string
+
+## Example
+
+```typescript
+import type { RootResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "service": null,
+  "docs": null,
+} satisfies RootResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RootResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ScoredChunkResponse.md

@@ -0,0 +1,65 @@
+
+# ScoredChunkResponse
+
+Chunk response with similarity score.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`pathPartId` | string
+`contentId` | string
+`content` | string
+`chunkType` | [ChunkType](ChunkType.md)
+`chunkMetadata` | [ChunkMetadataOutput](ChunkMetadataOutput.md)
+`parentPathId` | string
+`prevSiblingPathId` | string
+`nextSiblingPathId` | string
+`materializedPath` | string
+`systemManaged` | boolean
+`tenantId` | string
+`createdAt` | Date
+`updatedAt` | Date
+`assetS3Url` | string
+`score` | number
+
+## Example
+
+```typescript
+import type { ScoredChunkResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "pathPartId": null,
+  "contentId": null,
+  "content": null,
+  "chunkType": null,
+  "chunkMetadata": null,
+  "parentPathId": null,
+  "prevSiblingPathId": null,
+  "nextSiblingPathId": null,
+  "materializedPath": null,
+  "systemManaged": null,
+  "tenantId": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "assetS3Url": null,
+  "score": null,
+} satisfies ScoredChunkResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScoredChunkResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+